contact_list
Retrieve a filtered, paginated list of contacts and companies from Planfix, with custom field selection and change tracking for external integrations.
Instructions
Список контактов и компаний
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Fields returned - custom field identifiers, system field names, comma-delimited. <br>*Possible for system fields:* id, template, name, midname, lastname, gender, description, address, site, email, additionalEmailAddresses, skype, telegramId, telegram, facebook, instagram, viberId, position, group, isCompany, isDeleted, birthDate, createdDate, dateOfLastUpdate, supervisors, phones, companies, contacts, files, sourceObjectId, sourceDataVersion | |
| offset | No | Offset from beginning of list | |
| filters | No | ||
| filterId | No | Id for contact filter, get list by method '/contact/filters' | |
| pageSize | No | Size of requested list | |
| sourceId | No | Unique identifier of the third-party application or system. | |
| isCompany | No | True for companies / false for contacts | |
| prefixedId | No | Flag for retrieving id with a prefix | |
| onlyChanged | No | Flag for retrieving only data modified since last sync with external application |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | No | ||
| contacts | No |