API - Документация universam

Компании

Получить компании

Путь: /wp-json/usam/v1/companies

Метод запроса: GET

  • status — массив или строка, статус(не обязательный);
  • status__not_in — массив или строка, исключить со статусом указанным в параметре(не обязательный);
  • search — строка, поиск по номеру, названию, телефону, электронной почте, номеру счета (не обязательный);
  • count — число, количество в одном запросе, по умолчанию 10 (не обязательный);
  • paged — число, страница списка (не обязательный);
  • fields — массив, какие данные вернуть, если указать metas будут дополнены свойствами(не обязательный).

Результат:

Будет возвращен json, в котором будет

  • id — номер пользователя
  • logo — ссылка на логотип
  • name — название компании
  • manager_id — ответственный менеджер
  • date_insert — дата добавления в базу

Пример запроса

Получить компании со статусом «Перспективный»

 /wp-json/usam/v1/companies

{"status":"prospect"}

Получить компании с дополнительными полями

 /wp-json/usam/v1/companies

{"fields":["metas"]}

Поиск компаний по названию и получить дополнительные поля

 /wp-json/usam/v1/companies

{"search":"алгоритм","fields":["metas"]}