API Reference

Create a new person

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

Create a new person with the given details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null
Defaults to staff

The person's access level

boolean | null
Defaults to false

Whether provider is archived in Planbase

string | null

The person's cell phone number

client_assignments_in
array of objects | null

List of client assignments that this person has

Client Assignments In
custom_fields
object | null

List of custom fields that this person has

custom_option_ids
array of integers | null

List of custom option IDs associated with the person

Custom Option Ids
string
required

The person's email address

string | null

The person's employee ID

date | null

The date when the person's employment ended

string

The person's employment type, e.g. full-time or part-time

boolean | null
Defaults to false

Enable login for this person

boolean | null

Whether the person is exempt from overtime

string | null

The person's ID from an external system e.g payroll

string
required

The person's first name

boolean | null
Defaults to false

Whether the person's shifts are flexible

boolean | null
Defaults to false

Whether provider is currently active in Planbase

string
required

The person's last name

licenses_in
array of objects | null

List of new licenses that this person has

Licenses In
manager_assignments_in
array of objects | null

List of teams and roles this person manages

Manager Assignments In
integer | null

Maximum contracted daily hours

integer | null

Maximum contracted monthly hours

integer | null

Maximum contracted weekly hours

integer | null

Minimum contracted daily hours

integer | null

Minimum contracted monthly hours

integer | null

Minimum contracted weekly hours

string | null

The person's notes

boolean | null
Defaults to true

Whether person opts in to email communications

boolean | null
Defaults to true

Whether person opts in to Slack communications

boolean | null
Defaults to true

Whether person opts in to SMS communications

integer | null

The ID of the person's pay cycle

string | null

The name of the person's pay cycle

number | null

The person's pay rate

string

The person's rate type e.g. hourly or salary

regular_work_hours
object | null

The person's regular work hours as a JSON object

role_ids
array of integers | null

List of role IDs the person can perform

Role Ids
saved_filters
object | null

The person's saved filters

date | null

The start date of the person's employment

boolean | null

Whether the person submits their availability

boolean | null

Whether the person submits unavailability

team_ids
array of integers | null

List of team IDs the person is a member of

Team Ids
string | null

The timezone where the person works.

unavailability_allowances_in
array of objects | null

List of unavailability allowances that this person has

Unavailability Allowances In
unavailability_balances_in
array of objects | null

List of unavailability balances that this person has

Unavailability Balances In
string

Weekday start

integer | null

Minimum contracted weekends per month

string | null

The person's Recipient Currency from Wise

string | null

The person's Recipient ID from Wise

Responses

Updated 8 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?