Skip to main content
GET
/
v1
/
worker-beneficiaries
List worker beneficiaries
curl --request GET \
  --url https://api.plane.com/v1/worker-beneficiaries \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

Parameters

worker
string
Filter by worker.
type
string
Filter by beneficiary type.
status
string
Filter by status. One of active or inactive.
limit
integer
Number of beneficiaries to return.
cursor
string
Pagination cursor.

Returns

Returns a list object containing Worker beneficiary objects.