Teamwork

Official

Overview Schema Source Related Servers Discussions Admin

twprojects-list_users

Read-only

List users from Teamwork projects, filter by type (account, collaborator, contact), and paginate results. Retrieve selected fields for each user.

Instructions

List users. Scope by project_id or filter by type (account/collaborator/contact).

Input Schema

TableJSON Schema

Name	Required	Description
`page`	No	Page number for pagination of results (1-based).
`type`	No	Type of user to filter by. The available options are account, collaborator or contact.
`fields`	No	The attributes to return for each user, from the listed names.
`verbose`	No	If false, returns id + name only — useful when scanning many results.
`order_by`	No	The field to sort the users by. Omit to keep the ordering the API applies by default.
`page_size`	No	Number of results per page for pagination (1-500).
`count_only`	No	If true, return only {"count": N}: the exact number of matching users, no rows — use for "how many". Ignores page, page_size, verbose, fields.
`order_mode`	No	The direction to sort the results in.
`project_id`	No	The ID of the project from which to retrieve users. Omit to list users across all projects.
`search_term`	No	A search term to filter users by first or last names, or e-mail. The user will be selected if each word of the term matches the first or last name, or e-mail, not requiring that the word matches are in the same field.

Output Schema

TableJSON Schema

Name	Required	Description
`meta`	No
`count`	No	Exact number of matches across every page. Returned instead of the rows when count_only.
`people`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed26 schema fields changedv1.39.3Sep 9, 2026

removedInput schema / properties / count_only / anyOf

Removed value: -[
-  {
-    "type": "boolean"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / count_only / type
```
Added value: +"boolean"
```

removedInput schema / properties / fields / anyOf

Removed value: -[
-  {
-    "items": {
-      "enum": [
-        "id",
-        "firstName",
-        "lastName",
-        "title",
-        "email",
-        "isAdmin",
-        "type",
-        "userCost",
-        "userRate",
-        "company",
-        "jobRoles",
-        "skills",
-        "workingHour",
-        "lengthOfDay",
-        "deleted",
-        "createdBy",
-        "createdAt",
-        "updatedBy",
-        "updatedAt"
-      ],
-      "type": "string"
-    },
-    "type": "array"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / fields / items

Added value: +{
+  "enum": [
+    "id",
+    "firstName",
+    "lastName",
+    "title",
+    "email",
+    "isAdmin",
+    "type",
+    "userCost",
+    "userRate",
+    "company",
+    "jobRoles",
+    "skills",
+    "workingHour",
+    "lengthOfDay",
+    "deleted",
+    "createdBy",
+    "createdAt",
+    "updatedBy",
+    "updatedAt"
+  ],
+  "type": "string"
+}

addedInput schema / properties / fields / type
```
Added value: +"array"
```

removedInput schema / properties / order_by / anyOf

Removed value: -[
-  {
-    "enum": [
-      "name",
-      "namecaseinsensitive",
-      "company",
-      "id"
-    ],
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / order_by / enum

Added value: +[
+  "name",
+  "namecaseinsensitive",
+  "company",
+  "id"
+]

addedInput schema / properties / order_by / type
```
Added value: +"string"
```

removedInput schema / properties / order_mode / anyOf

Removed value: -[
-  {
-    "enum": [
-      "asc",
-      "desc"
-    ],
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / order_mode / enum
```
Added value: +[
+  "asc",
+  "desc"
+]
```
addedInput schema / properties / order_mode / type
```
Added value: +"string"
```

removedInput schema / properties / page / anyOf

Removed value: -[
-  {
-    "minimum": 1,
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / page / minimum
```
Added value: +1
```
addedInput schema / properties / page / type
```
Added value: +"integer"
```

removedInput schema / properties / page_size / anyOf

Removed value: -[
-  {
-    "maximum": 500,
-    "minimum": 1,
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / page_size / maximum
```
Added value: +500
```
addedInput schema / properties / page_size / minimum
```
Added value: +1
```
addedInput schema / properties / page_size / type
```
Added value: +"integer"
```

removedInput schema / properties / project_id / anyOf

Removed value: -[
-  {
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / project_id / type
```
Added value: +"integer"
```

removedInput schema / properties / search_term / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / search_term / type
```
Added value: +"string"
```

removedInput schema / properties / type / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / type / type
```
Added value: +"string"
```

removedInput schema / properties / verbose / anyOf

Removed value: -[
-  {
-    "type": "boolean"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / verbose / type
```
Added value: +"boolean"
```

Changed5 schema fields changedv1.31.0Aug 19, 2026

addedInput schema / properties / count_only

Added value: +{
+  "anyOf": [
+    {
+      "type": "boolean"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": false,
+  "description": "If true, return only {\"count\": N}: the exact number of matching users, no rows — use for \"how many\". Ignores page, page_size, verbose, fields."
+}

addedInput schema / properties / order_by

Added value: +{
+  "anyOf": [
+    {
+      "enum": [
+        "name",
+        "namecaseinsensitive",
+        "company",
+        "id"
+      ],
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The field to sort the users by. Omit to keep the ordering the API applies by default."
+}

addedInput schema / properties / order_mode

Added value: +{
+  "anyOf": [
+    {
+      "enum": [
+        "asc",
+        "desc"
+      ],
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The direction to sort the results in."
+}

addedOutput schema / properties / count

Added value: +{
+  "description": "Exact number of matches across every page. Returned instead of the rows when count_only.",
+  "type": "integer"
+}

addedOutput schema / properties / meta / properties / page / properties / count
```
Added value: +{
+  "type": [
+    "null",
+    "integer"
+  ]
+}
```

Changed1 schema field changedv1.27.2Aug 10, 2026

addedInput schema / properties / fields

Added value: +{
+  "anyOf": [
+    {
+      "items": {
+        "enum": [
+          "id",
+          "firstName",
+          "lastName",
+          "title",
+          "email",
+          "isAdmin",
+          "type",
+          "userCost",
+          "userRate",
+          "company",
+          "jobRoles",
+          "skills",
+          "workingHour",
+          "lengthOfDay",
+          "deleted",
+          "createdBy",
+          "createdAt",
+          "updatedBy",
+          "updatedAt"
+        ],
+        "type": "string"
+      },
+      "type": "array"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The attributes to return for each user, from the listed names."
+}

Changed4 schema fields changedv1.26.5Aug 5, 2026

changedInput schema / properties / page / anyOf

Previous value: -[
-  {
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "minimum": 1,
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

changedInput schema / properties / page / description

Previous value: -"Page number for pagination of results."New value: +"Page number for pagination of results (1-based)."

changedInput schema / properties / page_size / anyOf

Previous value: -[
-  {
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "maximum": 500,
+    "minimum": 1,
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

changedInput schema / properties / page_size / description

Previous value: -"Number of results per page for pagination."New value: +"Number of results per page for pagination (1-500)."

Addedv1.26.0Jul 30, 2026
Removedv1.25.0Jul 17, 2026

Changed1 schema field changedv1.20.3May 18, 2026

changedInput schema / properties / verbose / description

Previous value: -"If true (default), the response includes full entity details. If false, only a minimal subset of fields (typically an id and a name/title) is returned to reduce response size — useful when scanning many results to pick an id before fetching the full entity."New value: +"If false, returns id + name only — useful when scanning many results."

Changed27 schema fields changedv1.20.1May 15, 2026
- addedInput schema / properties / verbose
```
Added value: +{
+  "anyOf": [
+    {
+      "type": "boolean"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": true,
+  "description": "If true (default), the response includes full entity details. If false, only a minimal subset of fields (typically an id and a name/title) is returned to reduce response size — useful when scanning many results to pick an id before fetching the full entity."
+}
```
- removedOutput schema / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / meta / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / meta / properties / page / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / meta / properties / page / required
```
Removed value: -[
-  "hasMore"
-]
```
- removedOutput schema / properties / meta / required
```
Removed value: -[
-  "page"
-]
```
- removedOutput schema / properties / people / items / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / people / items / properties / company / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / people / items / properties / company / properties / meta / additionalProperties
```
Removed value: -true
```
- removedOutput schema / properties / people / items / properties / company / required
```
Removed value: -[
-  "id",
-  "type"
-]
```
- removedOutput schema / properties / people / items / properties / createdBy / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / people / items / properties / createdBy / properties / meta / additionalProperties
```
Removed value: -true
```
- removedOutput schema / properties / people / items / properties / createdBy / required
```
Removed value: -[
-  "id",
-  "type"
-]
```
- removedOutput schema / properties / people / items / properties / jobRoles / items / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / people / items / properties / jobRoles / items / properties / meta / additionalProperties
```
Removed value: -true
```
- removedOutput schema / properties / people / items / properties / jobRoles / items / required
```
Removed value: -[
-  "id",
-  "type"
-]
```
- removedOutput schema / properties / people / items / properties / skills / items / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / people / items / properties / skills / items / properties / meta / additionalProperties
```
Removed value: -true
```
- removedOutput schema / properties / people / items / properties / skills / items / required
```
Removed value: -[
-  "id",
-  "type"
-]
```
- removedOutput schema / properties / people / items / properties / updatedBy / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / people / items / properties / updatedBy / properties / meta / additionalProperties
```
Removed value: -true
```
- removedOutput schema / properties / people / items / properties / updatedBy / required
```
Removed value: -[
-  "id",
-  "type"
-]
```
- removedOutput schema / properties / people / items / properties / workingHour / additionalProperties
```
Removed value: -false
```
- removedOutput schema / properties / people / items / properties / workingHour / properties / meta / additionalProperties
```
Removed value: -true
```
- removedOutput schema / properties / people / items / properties / workingHour / required
```
Removed value: -[
-  "id",
-  "type"
-]
```
- removedOutput schema / properties / people / items / required
```
Removed value: -[
-  "id",
-  "firstName",
-  "lastName",
-  "title",
-  "email",
-  "isAdmin",
-  "type",
-  "userCost",
-  "userRate",
-  "company",
-  "workingHour",
-  "lengthOfDay",
-  "deleted",
-  "createdBy",
-  "createdAt",
-  "updatedBy",
-  "updatedAt"
-]
```
- removedOutput schema / required
```
Removed value: -[
-  "meta",
-  "people"
-]
```
Addedv1.18.3May 12, 2026
Removedv1.18.2May 11, 2026
Addedv1.17.2May 4, 2026

TDQS

A3.6/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is established; the description adds project/type scoping context. Like comparable read-only list tools, it does not mention pagination or response shape, but the output schema and parameter documentation cover those.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with no filler. The most relevant scoping and filtering facts are front-loaded immediately after the verb, making it easy to scan and understand.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only list tool with a full output schema and complete parameter documentation, the description provides enough high-level function and key filter modes for correct selection. It is slightly less rich than the best examples because it omits the all-projects default, but the schema states that explicitly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and every parameter has an explicit description, enum, or default. The description adds no meaning beyond the schema, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('List') and resource ('users'), plus the two key dimensions: project scope and account/collaborator/contact type. It is clear about what it does, though it does not explicitly contrast with sibling list tools such as twdesk-list_users or twprojects-get_user.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concise within-tool usage: scope by project_id or filter by type. It does not name alternatives or state when to prefer this over other user-listing tools, so the guidance is implied rather than explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server