Users

Список сотрудников

Все сотрудники пространства, кроме удалённых. Приостановленные приходят вместе с остальными и отличаются полем suspended.

Боты в пространстве — тоже сотрудники и приходят в общем списке с bot: true. Но из выдачи по query они исключены: чтобы найти бота по имени, перебирайте страницы без поискового запроса или пользуйтесь методом [Список ботов](GET /bots).

Почта и телефон приходят null, если в пространстве выключен показ персональных данных, а вызывающий не администратор.

Карточку одного сотрудника отдаёт [Информация о сотруднике](GET /users/{id}), свою — [Свой профиль](GET /profile).

get/users

Request

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

Query parameters

querystring
Example:Олег

Поисковая фраза для фильтрации результатов. Поиск работает по полям: first_name (имя), last_name (фамилия), email (электронная почта), phone_number (телефон) и nickname (никнейм).

limitinteger
Example:1

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

cursorstring
Example:eyJpZCI6MTAsImRpciI6ImFzYyJ9

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

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": {
    "paginate": {
      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3",
      "prev_page": "eyJxZCO2MiwiZGlyIjoiYXNjIn0",
      "has_next": true
    }
  }
}

Changes

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