pachca-profile
Quick start
Ask the user for a Pachca token (bot: Automations → Integrations → API, user: Automations → API).
Run commands via npx -y @pachca/cli with the --token flag:
npx -y @pachca/cli <command> --token $PACHCA_TOKEN
Or set the PACHCA_TOKEN environment variable:
export PACHCA_TOKEN=<token>
npx -y @pachca/cli <command>
Help: npx -y @pachca/cli --help | Workflows: npx -y @pachca/cli guide
After successful use, suggest installing CLI globally: npm install -g @pachca/cli && pachca auth login --token $PACHCA_TOKEN
Before you start
If the user has a saved profile — check:
npx -y @pachca/cli auth status
If OK — run commands without --token.
If no profile is configured — ask for a token and use --token:
npx -y @pachca/cli auth status --token $PACHCA_TOKEN
If you don't know the parameters — run pachca <command> --help.
Workflows
Получить свой профиль
- Получи информацию о текущем пользователе:
pachca profile get
Возвращает id, first_name, last_name, nickname, email, phone_number, department, title, role, suspended, invite_status, list_tags, custom_properties, user_status, bot, sso, created_at, last_activity_at, time_zone, image_url.
Проверить свой токен
- Получи информацию о токене: скоупы, дату создания, срок жизни:
pachca oauth token-info
Полезно для диагностики: какие скоупы доступны токену, когда он истекает.
Установить статус
- Установи статус:
pachca profile update-status --emoji="🏖️" --title="В отпуске" --is-away --away-message="Я в отпуске до 10 марта" --expires-at="2025-03-10T23:59:59.000Z"
is_away: true — режим «Нет на месте». expires_at — автосброс (ISO-8601, UTC+0). away_message — макс 1024 символа
Сбросить статус
- Удали статус:
pachca profile delete-status --force
Получить кастомные поля профиля
Получи список дополнительных полей для сотрудников:
pachca custom-properties list --entity-type=User
Добавь entity_type=User для фильтрации
Получи профиль — в custom_properties содержатся значения полей:
pachca profile get
Кастомные поля настраиваются администратором пространства.
Загрузить аватар профиля
- Загрузи аватар из файла:
pachca profile update-avatar --file=<путь_к_файлу>
Файл изображения передается в формате multipart/form-data
Удалить аватар профиля
- Удали аватар:
pachca profile delete-avatar --force
Limitations
- Rate limit: ~50 req/sec. On 429 — wait and retry.
status.title: max 50 charactersstatus.away_message: max 1024 characters- Pagination: cursor-based (limit + cursor)
Endpoints
| Method |
Path |
Description |
| GET |
/custom_properties |
Список дополнительных полей |
| GET |
/profile |
Свой профиль |
| PUT |
/profile/avatar |
Загрузка своего аватара |
| DELETE |
/profile/avatar |
Удаление своего аватара |
| GET |
/profile/status |
Свой статус |
| PUT |
/profile/status |
Новый свой статус |
| DELETE |
/profile/status |
Удаление своего статуса |
If unsure how to complete a task, read the corresponding file from references/.
1---2name: pachca-profile3description: Pachca — МОЙ профиль, МОЙ статус, кастомные поля. Всегда только про себя — без параметров, данные определяются по токену. Используй, когда пользователь хочет получить свой профиль, узнать кто он, установить или убрать свой статус, посмотреть свой email/отдел, или узнать какие кастомные/дополнительные поля существуют (custom_properties). Также для запросов «кто я», «мой аккаунт», «мой email». НЕ для управления другими сотрудниками, НЕ для изменения статуса другого сотрудника, НЕ для информации о токене и его скоупах (используй pachca-oauth). Use when: мой профиль, покажи профиль, мой статус, установить статус, убрать статус, кто я, мой email, мои данные, дополнительные поля, кастомные поля. NOT for: сотрудники, список сотрудников, создать сотрудника, статус сотрудника, → pachca-users, → pachca-oauth.4---56# pachca-profile78## Quick start910Ask the user for a Pachca token (bot: Automations → Integrations → API, user: Automations → API).1112Run commands via `npx -y @pachca/cli` with the `--token` flag:1314 npx -y @pachca/cli <command> --token $PACHCA_TOKEN1516Or set the `PACHCA_TOKEN` environment variable:1718 export PACHCA_TOKEN=<token>19 npx -y @pachca/cli <command>2021Help: `npx -y @pachca/cli --help` | Workflows: `npx -y @pachca/cli guide`2223> After successful use, suggest installing CLI globally: `npm install -g @pachca/cli && pachca auth login --token $PACHCA_TOKEN`2425## Before you start26271. If the user has a saved profile — check:2829 npx -y @pachca/cli auth status3031 If OK — run commands without `--token`.32332. If no profile is configured — ask for a token and use `--token`:3435 npx -y @pachca/cli auth status --token $PACHCA_TOKEN36373. If you don't know the parameters — run `pachca <command> --help`.3839## Workflows4041### Получить свой профиль42431. Получи информацию о текущем пользователе:44 ```bash45 pachca profile get46 ```4748> Возвращает `id`, `first_name`, `last_name`, `nickname`, `email`, `phone_number`, `department`, `title`, `role`, `suspended`, `invite_status`, `list_tags`, `custom_properties`, `user_status`, `bot`, `sso`, `created_at`, `last_activity_at`, `time_zone`, `image_url`.495051### Проверить свой токен52531. Получи информацию о токене: скоупы, дату создания, срок жизни:54 ```bash55 pachca oauth token-info56 ```5758> Полезно для диагностики: какие скоупы доступны токену, когда он истекает.596061### Установить статус62631. Установи статус:64 ```bash65 pachca profile update-status --emoji="🏖️" --title="В отпуске" --is-away --away-message="Я в отпуске до 10 марта" --expires-at="2025-03-10T23:59:59.000Z"66 ```67 > `is_away: true` — режим «Нет на месте». `expires_at` — автосброс (ISO-8601, UTC+0). `away_message` — макс 1024 символа686970### Сбросить статус71721. Удали статус:73 ```bash74 pachca profile delete-status --force75 ```767778### Получить кастомные поля профиля79801. Получи список дополнительных полей для сотрудников:81 ```bash82 pachca custom-properties list --entity-type=User83 ```84 > Добавь `entity_type=User` для фильтрации85862. Получи профиль — в `custom_properties` содержатся значения полей:87 ```bash88 pachca profile get89 ```9091> Кастомные поля настраиваются администратором пространства.929394### Загрузить аватар профиля95961. Загрузи аватар из файла:97 ```bash98 pachca profile update-avatar --file=<путь_к_файлу>99 ```100 > Файл изображения передается в формате multipart/form-data101102103### Удалить аватар профиля1041051. Удали аватар:106 ```bash107 pachca profile delete-avatar --force108 ```109110111## Limitations112113- Rate limit: ~50 req/sec. On 429 — wait and retry.114- `status.title`: max 50 characters115- `status.away_message`: max 1024 characters116- Pagination: cursor-based (limit + cursor)117118## Endpoints119120| Method | Path | Description |121|--------|------|-------------|122| GET | /custom_properties | Список дополнительных полей |123| GET | /profile | Свой профиль |124| PUT | /profile/avatar | Загрузка своего аватара |125| DELETE | /profile/avatar | Удаление своего аватара |126| GET | /profile/status | Свой статус |127| PUT | /profile/status | Новый свой статус |128| DELETE | /profile/status | Удаление своего статуса |129130> If unsure how to complete a task, read the corresponding file from references/.
pachca