cash.contact.search

Приложения » Деньги API »

Поиск контактов.

Параметры

  • term GET Необязательно

    Поисковый запрос для поиска контактов по части имени, email-адреса или номера телефона. Не должен быть пустым, если не заполнен параметр 'category_id'.

  • category_id GET Необязательно

    ID статьи доходов или расходов, если нужно получить контакты, связанные только с операциями этой статьи. Не должен быть пустым, если не заполнен параметр 'term'.

  • limit GET Необязательно

    Максимальное количество контактов, которое нужно получить. Не должен быть больше 30. Если не указано, используется значение по умолчанию 5.

  • format GET Необязательно

    Устанавливает формат ответа. Возможные значения: json (по умолчанию), xml.

Возвращаемое значение

Список найденных контактов. Каждый элемент списка — массив со следующими ключами:

  • []['id'] int ID контакта.
  • []['firstname'] string Имя.
  • []['lastname'] string Фамилия.
  • []['name'] string Полное имя.
  • []['label'] string HTML-код иконки размером 20х20 пикселей с фотографией контакта.
  • []['photo_url'] string Относительный URL уменьшенного изображения размером 96х96 пикселей.
  • []['photo_url_absolute'] string Абсолютный URL изображения.

Пример

https://demo1-ru.webasyst.com/api.php/cash.contact.search?