Get all people

get

https://api.joinplanbase.com/api/v1/people

Retrieve all people within the current user's organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

include

string | null

Object detail to be included with each person (e.g. 'teams, roles, licenses, payor_enrollments')

include_archived

boolean | null

Defaults to false

Include archived people in the response

include_non_archived

boolean | null

Defaults to true

Include non-archived people in the response

person_ids

array of integers | null

Filter people by person ids (e.g. '4,6,7,8')

Person Ids

team_ids

array of integers | null

Filter people by team ids (e.g. '4,6,7,8')

Team Ids

role_ids

array of integers | null

Filter people by role ids (e.g. '4,6,7,8')

Role Ids

client_ids

array of integers | null

Filter people by client ids (e.g. '4,6,7,8')

Client Ids

license_type_ids

array of integers | null

Filter people by license type ids (e.g. '4,6,7,8')

License Type Ids

skill_type_ids

array of integers | null

Filter people by skill type ids (e.g. '4,6,7,8')

Skill Type Ids

payor_ids

array of integers | null

Filter people by payor ids (e.g. '4,6,7,8')

Payor Ids

activity_type_ids

array of integers | null

Filter people by activity type ids (e.g. '4,6,7,8')

Activity Type Ids

shift_type_ids

array of integers | null

Filter people by shift type ids (e.g. '4,6,7,8')

Shift Type Ids

datastream_ids

array of integers | null

Filter people by datastream ids (e.g. '4,6,7,8')

Datastream Ids

pay_cycle_ids

array of integers | null

Filter people by pay cycle ids (e.g. '4,6,7,8')

Pay Cycle Ids

custom_field_filters

string | null

Filter people by custom field filters (e.g. 'custom_field_id:12345,value:12345')

custom_object_reference_filters

string | null

Filter people by custom object reference filters (e.g. 'custom_object_id:12345,custom_field_id:12345')

filter_type

string

enum

Defaults to OR

Filter type to use ('AND' or 'OR')

Allowed:

filter_start

date | null

Start date to be used when applying relevant filters (e.g. license types, client assignments, payor enrollments, pay cycles)

filter_end

date | null

End date to be used when applying relevant filters (e.g. license types, client assignments, payor enrollments, pay cycles)

fields

array of strings | null

Specify which fields should be returned (e.g. 'id,first_name,last_name')

Fields

include_past_assignments

boolean | null

Defaults to false

Whether to look at past team and roleassignments when filtering

Responses

200Returns the current user's details.

422Validation Error