API Reference

Create Employee

post
https://api.branchapp.com/v1/organizations//employees/

Create a new employee. Updates if the employee already exists.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Organization ID

string
required

Employee ID

Body Params
string
required
length ≥ 1

First name of employee. Numbers not allowed

string
required
length ≥ 1

Last name of employee. Numbers not allowed

string

Phone number of employee. Required for Branch Direct

string

Email address of employee. Required for Branch Direct

string
enum

The employee's wage type

Allowed:
int32
≥ 0

Rate of pay, in cents, used in conjunction with type. The following should be defined as follows: If type = salary, then should be the annual salary of the employee If type = hourly, then should be the hourly rate the employee earns

string

A cosmetic descriptor of the employee's workplace

string

An additional layer of categorization within an organization allowing for more granular customized settings

string

9 digit employer identification number

string

Password of the employee

string

Valid U.S. 2-character state abbreviation.

Responses

Updated 9 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago