---
title: "List Users"
method: POST
path: "/{platform}/users"
---

# List Users

`POST /{platform}/users`

## Request

- Base URL: `https://api.traversal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.traversal.com/{platform}/users`
- Auth: none declared

## Path parameters

- `platform` 'slack' | 'teams' | 'web', required: A supported chat platform. Values align with ``integration_instances.type`` so a chat install's platform and its integration row stay in lockstep.

## Request body

- GetChatPlatformUsersRequest
  - `organization_id` string, required
  - `channel_id` string, nullable

## Response `200`

Successful Response

- ChatPlatformUserResponse[]
  - `id` string, required
  - `platform` 'slack' | 'teams' | 'web', required: A supported chat platform. Values align with ``integration_instances.type`` so a chat install's platform and its integration row stay in lockstep.
  - `platform_user_id` string, required
  - `organization_id` string, required
  - `integration_id` string, nullable, required
  - `workspace_id` string, required
  - `user_id` string, nullable, required
  - `username` string, nullable, required
  - `display_name` string, nullable, required
  - `real_name` string, nullable, required
  - `first_name` string, nullable, required
  - `last_name` string, nullable, required
  - `email` string, nullable, required
  - `title` string, nullable, required
  - `phone` string, nullable, required
  - `avatar_url` string, nullable, required
  - `is_bot` boolean, required
  - `is_automation` boolean, required
  - `platform_updated_at` string, date-time, nullable, required
  - `deactivated_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `last_updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

## Changes

> 66 revisions in range; 9 not diffed.

- **2026-09-23** `3da9c3d0385f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/traversal/apis/traversal-api/changes/:platform/users/post.md)

---

[API](https://skmtc.dev/traversal/apis/traversal-api.md) - [All operations](https://skmtc.dev/traversal/apis/traversal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/traversal/apis/traversal-api/revisions/31e1a8b7cf89?raw)