Skip to content

List persons

GET
/v1/persons

Lists the active org's people. Each row carries work-only identity (legal name, preferred name, work email, photo) plus a memberships array scoped to the active org. Demographic columns on Person (gender, ethnicity, DOB, country) are never exposed. Returns up to 500 rows (no pagination in v1).

Authorizations

BearerAuth

API key in the form one_pk_<random>. Mint at /settings/api-keys.

Type
HTTP (bearer)

Parameters

Query Parameters

status

Filter by membership status. all returns everyone (incl. terminated); default is active.

Type
string
Valid values
"active""inactive""all"
Example"example"

Responses

Array of person envelopes with total count.

application/json
JSON
{
  
"meta": {
  
  
"version": 0,
  
  
"total": 0
  
},
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"party_id": "string",
  
  
  
"legal_name": "string",
  
  
  
"preferred_name": "string",
  
  
  
"trading_name": "string",
  
  
  
"work_email": "string",
  
  
  
"photo_url": "string",
  
  
  
"memberships": [
  
  
  
  
{
  
  
  
  
  
"membership_id": "string",
  
  
  
  
  
"organization_id": "string",
  
  
  
  
  
"role": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"department_id": "string",
  
  
  
  
  
"employment_start_date": "string",
  
  
  
  
  
"termination_date": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string"
  
  
}
  
]
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

OneBusiness · Built for businesses that work.