---
title: "List End Users"
method: GET
path: "/api/v1/end-users"
tags: ["end-users"]
---

# List End Users

`GET /api/v1/end-users`

## Request

- Base URL: `https://api.maritime.sh` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maritime.sh/api/v1/end-users`
- Auth: HTTP bearer

Lists the account's end users one page at a time, newest first unless sorted by activity.

## Query parameters

- `status` string, nullable
- `tag` string, nullable
- `externalIdPrefix` string, nullable
- `lastActiveBefore` string, date-time, nullable
- `lastActiveAfter` string, date-time, nullable
- `q` string, nullable: Matches an external id prefix or a display name
- `projectId` string, nullable: Only users of this agent group
- `agentId` string, nullable: Only the user that owns this agent
- `sort` string: created or lastActive
- `cursor` string, nullable
- `limit` integer

## Response `200`

Successful Response

- EndUserList: One page of end users.
  - `items` EndUserResponse[], required
    - `id` string, required
    - `externalId` string, required
    - `displayName` string, nullable
    - `metadata` object
    - `tags` string[]
    - `status` string, required
    - `policy` object, nullable
    - `agentCount` integer
    - `agents` EndUserAgentSummary[]
      - `id` string, required
      - `name` string, required
      - `status` string, required
      - `framework` string, nullable
      - `templateId` string, nullable
      - `projectId` string, nullable
      - `projectRole` string, nullable
      - `baseAgent` BaseAgentRef: The product an end user's agent was stamped from: the base agent of its project.
        - `id` string, required
        - `name` string, required
      - `createdAt` string, date-time, required
      - `lastActiveAt` string, date-time, nullable
    - `aiSpendCents30d` number
    - `messageCount` integer
    - `lastMessage` EndUserLastMessage: The last thing said between the end user and their agent.
      - `at` string, date-time, required
      - `fromAgent` boolean, required
      - `text` string, nullable
      - `imageCount` integer
      - `failed` boolean
    - `activity14d` integer[]
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `lastActiveAt` string, date-time, nullable
  - `nextCursor` string, nullable

## Other responses

- `422`: Validation Error

---

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