People API - LowerPlane Documentation

Overview

The People API provides read-only access to your organization’s people directory — employees and personnel synced from HR integrations or added manually. Use it to reference person IDs when assigning asset owners via the Assets API, or to reconcile your HR systems with LowerPlane. All endpoints require API key authentication.

The People API is read-only. People are managed through the LowerPlane dashboard or HR integrations (BambooHR, HiBob, Workday, and others).

List People

GET /api/v1/external/people

string

Filter by status, e.g., active, offboarded.

string

Filter by department name.

string

Filter by employment type, e.g., full_time, contractor.

string

Filter by job title.

string

Search by name or email.

string

default:"last_name"

Sort field.

string

default:"asc"

Sort direction: asc or desc.

number

default:"1"

Page number.

number

default:"20"

Results per page.

Example

curl "https://app.lowerplane.com/api/v1/external/people?status=active&department=Engineering" \
  -H "Authorization: Bearer lp_your_api_key"

import requests

response = requests.get(
    "https://app.lowerplane.com/api/v1/external/people",
    headers={"Authorization": "Bearer lp_your_api_key"},
    params={"status": "active", "page": 1, "limit": 50},
)
for person in response.json()["data"]:
    print(person["id"], person["firstName"], person["lastName"])

Response

Returns a paginated list of people. Each person includes:

string

The person’s UUID. Use this as owner_id when creating or updating assets.

string

First name.

string

Last name.

string

Work email address.

string

Employment status, e.g., active, offboarded.

string

Department name.

string

Job title.

string

Employment type, e.g., full_time, contractor.

string

Start date (ISO 8601).

Error Responses

Status	Error	Description
401	—	Authentication failure (see Authentication)

​Overview

​List People

​Example

​Response

​Error Responses

Overview

List People

Example

Response

Error Responses