Skip to content

List memberships

GET
/v1/memberships

Lists the active org's employment relationships (Membership rows). Includes role, status, department, employment dates, and current reporting manager. Compensation is fetched separately via /compensation/:membershipId. Closed memberships are visible only with ?status=all.

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 every status; default is active.

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

Filter by department id. Unknown ids return an empty list.

Type
string
Example"example"

Responses

Array of membership envelopes with total count.

application/json
JSON
{
  
"meta": {
  
  
"version": 0,
  
  
"total": 0
  
},
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"person_id": "string",
  
  
  
"user_id": "string",
  
  
  
"organization_id": "string",
  
  
  
"role": "string",
  
  
  
"status": "string",
  
  
  
"department_id": "string",
  
  
  
"employment_start_date": "string",
  
  
  
"termination_date": "string",
  
  
  
"manager_membership_id": "string",
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string"
  
  
}
  
]
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

OneBusiness · Built for businesses that work.