Get 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

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

include_archived

Include archived people in the response

include_non_archived

Include non-archived people in the response

person_ids

array | null

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

team_ids

array | null

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

role_ids

array | null

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

client_ids

array | null

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

license_type_ids

array | null

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

skill_type_ids

array | null

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

payor_ids

array | null

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

activity_type_ids

array | null

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

shift_type_ids

array | null

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

datastream_ids

array | null

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

pay_cycle_ids

array | null

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

custom_field_filters

Filter people by custom field filters (JSON object, e.g. {"12345":[1,2]})

custom_object_reference_filters

Filter people by custom object reference filters (JSON object, e.g. {"27":{"12345":[1,2]}})

filter_type

FilterType | null

Defaults to OR

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

filter_start

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

filter_end

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

fields

array | null

Specify which fields should be returned (e.g. ["id", "first_name", "last_name"])

include_past_assignments

Whether to look at past team and roleassignments when filtering

use_custom_field_ids

Use custom field IDs as keys instead of names

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the current user's details.

422Validation Error