API Reference
  1. Branch API
  2. V2 Shifts

Submit Shift

post
https://api.branchapp.com/v2/organizations//workers//shifts

Submit a person's completed shift. Shifts are used to track hours worked by an individual worker and calculate EWA. Shifts may be created with a shift_id unique within the organization. Successful call will return the created shift and status 201.

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

Organization ID

string
required

Worker ID

Body Params
string

If blank, defaults to UUID

double
≥ 0

Number of hours worked in the shift. This value cannot be negative. This does not need to be provided if 'punch_out' is provided

date-time

Time the shift started

date-time

Time the shift ended. This does not need to be provided if 'hours' is provided

int32

Amount of money, in cents, the employee made per hour

string
length between 0 and 36

A grouping for the worker. This could be anything that is used by your organization in order to group workers: store id, worker tier, region code, etc.

Responses

Updated 3 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 3 months ago