Search

Поиск сотрудников

Ищет сотрудников по имени и фамилии, нику, должности и отделу. Опечатки прощаются только в имени и фамилии, остальным полям нужно точное слово.

По почте метод ищет лишь тем, кому в пространстве видны персональные данные. По телефону он не ищет вовсе — для этого есть [Список сотрудников](GET /users) с параметром query.

Удалённые сотрудники не находятся никогда, приостановленные — только когда задан текстовый запрос, и стоят в выдаче ниже остальных. Из ботов находятся лишь публичные.

get/search/users

Request

  • Base URL: https://api.pachca.com/api/shared/v1
  • URL: https://api.pachca.com/api/shared/v1/search/users
  • Auth: HTTP bearer

Query parameters

querystring
Example:Олег

Текст поискового запроса

limitinteger
Example:10

Количество возвращаемых результатов за один запрос

cursorstring
Example:eyJpZCI6MTAsImRpciI6ImFzYyJ9

Курсор для пагинации (из meta.paginate.next_page)

sort'by_score' | 'alphabetical' | 'creation'

Сортировка результатов поиска

Сортировка результатов

order'asc' | 'desc'

Порядок сортировки

Направление сортировки

created_fromstring date-time
Example:2025-01-01T00:00:00.000Z

Фильтр по дате создания (от)

created_tostring date-time
Example:2025-02-01T00:00:00.000Z

Фильтр по дате создания (до)

company_rolesUserRole[]

Фильтр по ролям сотрудников

[
  "admin",
  "user"
]

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": 12,
      "first_name": "Олег",
      "last_name": "Петров",
      "nickname": "olegpetrov",
      "email": "olegp@example.com",
      "phone_number": "+79001234567",
      "department": "Продукт",
      "title": "CIO",
      "inviter_id": 185,
      "list_tags": [
        "Product",
        "Design"
      ],
      "custom_properties": [
        {
          "id": 1678,
          "name": "Город",
          "value": "Санкт-Петербург"
        }
      ],
      "user_status": {
        "emoji": "🎮",
        "title": "Очень занят",
        "expires_at": "2024-04-08T10:00:00.000Z",
        "away_message": {
          "text": "Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov."
        }
      },
      "created_at": "2020-06-08T09:32:57.000Z",
      "last_activity_at": "2025-01-20T13:40:07.000Z",
      "time_zone": "Europe/Moscow",
      "image_url": "https://app.pachca.com/users/12/photo.jpg"
    }
  ],
  "meta": {
    "total": 42,
    "paginate": {
      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.