Skip to main content
GET
List People

Authorizations

Authorization
string
header
required

Workspace API key as a bearer token: Authorization: Bearer ish_sk_live_.... Keys are workspace-scoped machine principals minted in Settings > Developers (shown once at mint). Scopes: sessions:run (create a session, submit turns, close), sessions:read (read the session and its decision trace), environments:read and environments:write (manage the workspace's registered environments), tasks:read and tasks:write (manage the workspace's registered tasks), people:read and people:write (the people the workspace can run a session for), and usage:read (the workspace's own consumption, spend limits and rate-limit budgets). A key is minted with sessions:run, sessions:read, and tasks:read by default; every other scope must be requested, people:read and usage:read included. An ish user access token also works on the same header for personal scripts.

Path Parameters

workspace_id
string<uuid>
required

Query Parameters

owner
string | null

Restrict to one owner: self for people this workspace owns, platform for the shared ish library. Omit it to get both, which is exactly the set you can open a session for.

Pattern: ^(self|platform)$
search
string | null

Case-insensitive substring match on the person's name.

Maximum string length: 200
external_id
string | null

Look a person up by the id YOUR system gave them. Exact match, and at most one person can carry it, so a hit is a one-item page and a miss is an empty one. This is the lookup, and it lives here rather than on a path so that a missing external id is an empty result rather than a 404 you have to branch on.

Maximum string length: 255
generation_job_id
string<uuid> | null

Restrict to the people one generation job produced. This is how a job's results are collected: poll the job, then list by its id. Reads its own writes.

archived
boolean
default:false

false (the default) lists live people; true lists the archive instead. The two sets are disjoint, so this chooses which one you are looking at rather than widening the list.

after
string | null

Opaque keyset cursor from a prior page's next_cursor.

limit
integer
default:25
Required range: 1 <= x <= 100

Response

Successful Response

A keyset-paginated page of people.

Ordered created_at DESC, id DESC, the same order and the same envelope as the session list, so one pagination helper in an SDK drives both.

has_more
boolean
required

True when more people exist beyond this page.

items
PublicPersonResponse · object[]
required
next_cursor
string | null
required

Opaque keyset cursor for the next page (pass as after); null on the final page.