List People
list-people-toolRead-onlyIdempotent
List people (contacts) in the CRM with optional filters and pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (max 1,000,000). | |
| sort | No | Sort by field. Properties: field (string), direction (asc|desc). | |
| filter | No | An object of conditions. Keys starting with $ are keywords: operators ($eq, $contains, $is_empty, $gt, $gte, $lt, $lte, $has_any, $has_none, $in, $not_in) and logic ($and and $or take a list of condition objects, $not takes one and also returns records where the inner fields are empty). Other keys are names. A filter holds at most 20 conditions, 3 levels of $and, $or and $not, and 2 levels of relations. A list holds at most 100 values. Email values match in any letter case. Phone values match in any format, and the operand needs a country code such as +1 415 555 0100. Link values match in any letter case, with or without the scheme. Domain values match as a bare host or a full URL, with or without www. Tags-input values match the exact stored value. Date-time values match a date without a time, such as 2026-10-01, as that whole day. Email and link fields also take a domain sub-field with $in or $not_in, such as {"domain":{"$in":["acme.com"]}}, which matches the host of each value. $not_in and $has_none also match records where the field is empty. $is_empty takes true or false. Native fields: name, created_at, updated_at, creation_source. Relations take $in, $not_in or $is_empty on record ids, or conditions on the related record that use that record type's own filter names, including custom_fields. Prefer conditions over listing the related records first and passing their ids: company (company). Member relations take $in, $not_in or $is_empty on workspace member ids only, with no nested conditions: creator. custom_fields takes an object keyed by custom field code, each value an operator object. Native fields and relations sit at the top level of filter. get-crm-schema-tool lists those codes with their type and options under filterable_fields.custom_fields, and the operators, matching rule and example of each type under filterable_fields.types. Example: {"name":{"$contains":"Acme"},"$or":[{"creation_source":{"$eq":"api"}},{"created_at":{"$gte":"2026-01-01"}}]}. | |
| include | No | Singular relationships or relationship counts to expand. Use a show tool for to-many records. | |
| per_page | No | Results per page (default 15, max 25). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| items | Yes | ||
| total | Yes | ||
| has_more | Yes | ||
| per_page | Yes | ||
| next_page | Yes |