> ## Documentation Index
> Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# List Users

> List Users: listUsers in the TypeScript, Python, Rust and Go clients.

`GET /v1/projects/{id}/users`

Lists stored Users without refreshing their classification; use Get User for current details. Message filters select incoming senders or outgoing recipients, excluding the Message's own endpoint.

**TypeScript**

```typescript TypeScript theme={null}
photon.projects.listUsers(input: ListUsersInput, options?: RequestOptions): Promise<ListUsersOutput>
```

**Python**

```python Python theme={null}
photon.projects.list_users(input: ListUsersInput) -> models.UserPage
```

**Rust**

```rust Rust theme={null}
client.list_users(id: String, params: Option<ListUsersParams>).await -> Result<ResponseValue<types::UserPage>, Error<ListUsersError>>
```

**Go**

```go Go theme={null}
client.Projects.ListUsers(ctx context.Context, params *ListUsersParams, opts ...RequestOption) (*UserPage, error)
```

```typescript TypeScript theme={null}
import { Photon } from "@photon-ai/api";

const photon = new Photon({
  headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.projects.listUsers({
  path: {
    id: "id",
  },
});
```

```python Python theme={null}
import os

from photon_api import Photon
from photon_api.rpc_generated import ListUsersInput

photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.projects.list_users(
    ListUsersInput.model_validate({
        "path": {
            "id": "id",
        },
    })
)
```

```rust Rust theme={null}
use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
    .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
    .build()?;
let result = client
    .list_users("id".to_owned(), None)
    .await
    .map_err(|error| format!("{error:?}"))?
    .into_inner();
```

```go Go theme={null}
import (
	"context"
	"os"

	photonapi "github.com/photon-hq/api/packages/go"
)

ctx := context.Background()
client := photonapi.NewClient(photonapi.WithAPIKey(os.Getenv("PHOTON_API_TOKEN")))
result, err := client.Projects.ListUsers(ctx, &photonapi.ListUsersParams{
	ID: "id",
})
if err != nil {
	return err
}
_ = result
```

```json 200 theme={null}
{
  "items": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "details": {
        "resourceId": "pho_res_00000000000000000000000001",
        "type": "dedicated"
      },
      "handle": "+14155550123",
      "id": "pho_usr_00000000000000000000000001",
      "kind": "agent",
      "metadata": {},
      "platform": "whatsapp",
      "projectId": "pho_prj_00000000000000000000000001",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}
```

## Parameters

**id** `string` *required*

**messageCreatedBefore** `string (date-time)`

Exclusive creation-time bound on a matching Message

**messageCreatedSince** `string (date-time)`

Inclusive creation-time bound on a matching Message

**messageDirection** `MessageDirection`

Received or sent Message. All message-prefixed filters must match the same Message.

**messageExcludeContentTypes** `string`

Comma-separated public content types to exclude from matching Messages. Requires messageResourceId. A group is excluded when its type or all its parts are excluded.

**messageResourceId** `string`

Resource ownership captured by a matching Message

**createdBefore** `string (date-time)`

Exclusive upper bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds.

**createdSince** `string (date-time)`

Inclusive lower bound on createdAt, RFC 3339. Cannot combine with updatedAt bounds.

**order** `SortOrder`

Direction along orderBy; desc, the default, is newest first

**orderBy** `TimestampOrderBy`

Sort timestamp; defaults to the filtered timestamp, otherwise created\_at. Must match the time bounds.

**pageSize** `integer`

Items per page. A value above 100 returns at most 100 items.

**pageToken** `string`

Token from nextPageToken. Keep the same Project and query.

**platform** `Platform`

Restricts the page to one platform

**updatedBefore** `string (date-time)`

Exclusive upper bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds.

**updatedSince** `string (date-time)`

Inclusive lower bound on updatedAt, RFC 3339. Cannot combine with createdAt bounds.

## Returns

**`200`** A page of persisted Users in the requested order. UserPage

Headers: `Cache-Control`, `ETag`. The raw response carries these headers; see [Raw responses](https://docs.photon.codes/docs/beta/api-client/raw-responses.md).

**items** `array of PlatformUser` *required*

Unsupported platforms and records with unsupported data are omitted.

**nextPageToken** `string`

Continue with this token, even if items is empty. Omitted when no more pages remain.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.