Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы
Редакторы
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
Команда
Команда
Мобильные редакторы
Мобильные редакторы
Облачный офис
Облачный офис
Почта
Почта
Органайзер
Органайзер
Сервер лицензирования
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

Получить отфильтрованные контакты

Обновлено: 12.02.26

GET api/2.0/crm/contact/filter

Важно

Для этой функции требуется аутентификация.

Описание

Возвращает список всех контактов в модуле CRM, соответствующих параметрам, указанным в запросе.

Параметры

Название Описание Тип Пример
tags
sent in url
Тег контакта
Необязательно
строковые коллекции

Коллекции

правда
contactStage
sent in url
Contact stage ID (warmth)
Необязательно
номер 1234
contactType
sent in url
Идентификатор типа контакта
Необязательно
номер 1234
contactListView
sent in url
Просмотр списка контактов
Допустимые значения: Company, Person, WithOpportunity
Необязательно
All, Company, Person, WithOpportunity
fromDate
sent in url
Дата начала
Необязательно
дата и время Roundtrip format: 2008-04-10T06-30-00.000Z
toDate
sent in url
Дата конца
Необязательно
дата и время Roundtrip format: 2008-04-10T06-30-00.000Z
responsibleid
sent in url
Идентификатор ответственного
Необязательно
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
isShared
sent in url
Конфиденциальность контакта: частная или нет
Необязательно
логический правда

Пример

GET api/2.0/crm/contact/filter?tags=%5b%22some+text%22%5d&contactListView=all&fromDate=2008-04-10T06-30-00.000Z&toDate=2008-04-10T06-30-00.000Z
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

Возвращает

Список контактов.

Пример ответа

application/json

{
  "status": 0,
  "response": [
    {
      "firstName": "Tadjeddine",
      "lastName": "Bachir",
      "company": {
        "companyName": "Food and Culture Project",
        "about": "",
        "haveLateTasks": false,
        "displayName": null,
        "isCompany": true,
        "isPrivate": true,
        "isShared": false,
        "shareType": 0,
        "currency": null,
        "canEdit": false,
        "canDelete": false,
        "id": 0
      },
      "title": "Programmer",
      "createBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2022-10-07T10:03:01.5035397Z",
      "about": "",
      "commonData": [
        {
          "id": 0,
          "infoType": 1,
          "category": 0,
          "data": "support@Р7.com",
          "categoryName": "Home",
          "isPrimary": true
        }
      ],
      "customFields": [
        {
          "entityId": 14523423,
          "label": "Birthdate",
          "fieldValue": "2022-10-07T10:03:01.5035397Z",
          "fieldType": 5,
          "position": 10,
          "mask": "",
          "id": 0
        }
      ],
      "haveLateTasks": false,
      "displayName": null,
      "isCompany": false,
      "isPrivate": true,
      "isShared": false,
      "shareType": 0,
      "currency": null,
      "canEdit": true,
      "canDelete": true,
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <firstName>Tadjeddine</firstName>
    <lastName>Bachir</lastName>
    <company>
      <companyName>Food and Culture Project</companyName>
      <about></about>
      <haveLateTasks>false</haveLateTasks>
      <displayName />
      <isCompany>true</isCompany>
      <isPrivate>true</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </company>
    <title>Programmer</title>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <created>2022-10-07T10:03:01.5035397Z</created>
    <about></about>
    <commonData>
      <id>0</id>
      <infoType>1</infoType>
      <category>0</category>
      <data>support@Р7.com</data>
      <categoryName>Home</categoryName>
      <isPrimary>true</isPrimary>
    </commonData>
    <customFields>
      <entityId>14523423</entityId>
      <label>Birthdate</label>
      <fieldValue>2022-10-07T10:03:01.5035397Z</fieldValue>
      <fieldType>5</fieldType>
      <position>10</position>
      <mask></mask>
      <id>0</id>
    </customFields>
    <haveLateTasks>false</haveLateTasks>
    <displayName />
    <isCompany>false</isCompany>
    <isPrivate>true</isPrivate>
    <isShared>false</isShared>
    <shareType>0</shareType>
    <currency />
    <canEdit>true</canEdit>
    <canDelete>true</canDelete>
    <id>0</id>
  </response>
</result>

Была ли эта статья полезной?

Поделитесь пожалуйста своим мнением

      В статье есть ошибкиРекомендации не помоглиТекст трудно понятьСодержание статьи не соответствует заголовкуДругое