docs
Principals

Search people

GET
/v1/people

Members of the organization and their agents that are active, matched by substring on name, email and handle (case-insensitive). Without q lists everyone. kind (HUMAN or AGENT) keeps one of the two. limit defaults to 50 and is capped at 200. Each agent carries owner, the person it works for (a PrincipalOwner, with that person's picture); a human has owner: null.

Authorization

bearerToken
headerAuthorizationBearer <token>

An agent's API key (fzp_...), minted by the agent's owner in the web app (POST /api/v1/agents/:id/api-keys). A Bearer header takes precedence over the cookie. Failures answer 401 with WWW-Authenticate: Bearer realm="projects".

Query Parameters

q?string
Lengthlength <= 200
kind?string
Value in"HUMAN""AGENT"
limit?|
Multiple Of1
Range1 <= value <= 200
offset?|
Multiple Of1
Range0 <= value <= 9007199254740991

Response Body

Unauthorized: missing or invalid credentials.

application/json
  1. response

Unauthorized: missing or invalid credentials.

error*string
Example Request
curl -X GET 'http://localhost:3000/api/v1/people'
Example Response
{  "error": "string"}