NAV
CURL

Quick Start

        

API Endpoint

https://api.localtable.co/v1/

The LocalTable API is the primary way to get data in and out of LocalTable's application. The LocalTable API is designed to have structured, easy-to-use URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication, which can be understood by off-the-shelf HTTP clients. JSON will be returned in all responses from the API, including errors. You can view code examples in the dark area to the right.

The current version of the API is v1.0. You will need to append the version identifier to the end of the request path. For example, here's a call to v1.0

Authentication

        

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/event \ -u auth_api_key:password -h "Content-Type: application/json"

curl uses the -u flag to pass basic auth credentials.

You authenticate to the LocalTable API by providing your unique API key in the request. You are assigned an API key upon signing up as an accredited partner. Your API key contains great power, so be sure to keep them secret! Authentication to the API occurs via HTTP Basic Auth. Provide your API key as the basic auth username. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests. All API requests must be passed using JSON.

Errors

LocalTable uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, an event update failed, etc.), and codes in the 5xx range indicate an error with LocalTable's servers.

Error Code Meaning
200 OK – Everything worked as expected.
400 Bad Request – Often missing a required parameter.
401 Unauthorized – No valid API key provided.
402 Request Failed – Parameters were valid but request failed.
404 Not Found – The requested item doesn't exist.
500, 502, 503, 504 Server errors – something went wrong on our end.

Event Method

Create an Event

DEFINITION

POST https://api.localtable.co/v1/event

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/event \ -u auth_api_key:password -h "Content-Type: application/json" { "ext_id": "12345", "name": "Dinner Event", "venue": "venue_aJk1am", "uniform": "uniform_533sahEJ", "start_date": 1414594154, "end_date": 1418563479, "description": "There will be 50 guests at 10 tables." }
    

EXAMPLE RESPONSE

{ "id": "event_BQokikJ0", "ext_id": "12345", "name": "Dinner Event", "venue": "Park Plaza Hotel", "uniform": "Black Pants & White Collard Shirt", "start_date":1414594154, "end_date":1418563479, "description": "There will be 50 guests at 10 tables." }

This method is used to create a new event for an authenticated user.

Arguments

Parameter Default Description
ext_id optional: string An external id can be used within a company who maintains their own identifier for a specific event.
name required: string An event name is required and helps describe the event being created.
venue required: LocalTable id A venue is required and dictates where the event will be hosted. The venue is passed using a LocalTable desginated identifier.
uniform required: LocalTable id A uniform is required and dictates what the staff member will be requested to wear. The uniform is passed using a LocalTable desginated identifier.
start_date required: UNIX timestamp The start date is required. It determines the start date and time of an event.
end_date required: UNIX timestamp The end date is required. It determines the end date and time of an event.
description optional: string An event description is optional but recommended as it helps store additional information about an event.

Response

Returns an event object if the event was created. Returns an error if something goes wrong.

Retrieve an Event

DEFINITION

GET https://api.localtable.co/v1/event/{EVENT_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/event/event_14tHpXzLTcWdT91 \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "event_BQokikJ0", "ext_id": "12345", "name": "Dinner Event", "venue": "Park Plaza Hotel", "uniform": "Black Pants & White Collard Shirt", "start_date":1414594154, "end_date":1418563479, "description": "There will be 50 guests at 10 tables." }

Retrieves the details of an existing event. You only need to supply the unique event identifier that was returned upon event creation.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the event to be retrieved.

Response

Returns an event object if a valid identifier was provided, and returns an error otherwise.

Retrieve all Events

DEFINITION

GET https://api.localtable.co/v1/events

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/events \ -u auth_api_key:password
    

EXAMPLE RESPONSE

[ { "id": "event_BQokikJ0", "ext_id": "12345", "name": "Dinner Event", "venue": "Park Plaza Hotel", "uniform": "Black Pants & White Collard Shirt", "start_date":1414594154, "end_date":1418563479, "description": "There will be 50 guests at 10 tables." }, {...}, {...}, {...} ]

Retrieves the details of all existing events.

Response

Returns an array of event objects if object exists, and returns an error otherwise.

Retrieve Event Costs

DEFINITION

GET https://api.localtable.co/v1/event/{EVENT_ID}/actuals

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/event/event_14tHpXzLTcWdT91/actuals \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "event_BQokikJ0", "name": "Dinner Event", "total_cost": 1500.00, "staff_count": 5, "staff": [ { “staff_id”: staff_12SDfnz29Fam, “clockin”: 1427763943, “clockout”: 1429635943, “cost”: 300 }, {…}, {…}, {…}, {…} ], }

Retrieves the cost details of an existing event. You only need to supply the unique event identifier that was returned upon event creation.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the event to be retrieved.

Response

Returns an event actuals object if a valid identifier was provided, and returns an error otherwise.

Retrieve Event Estimates

DEFINITION

GET https://api.localtable.co/v1/event/{EVENT_ID}/estimates

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/event/event_14tHpXzLTcWdT91/estimates \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "event_BQokikJ0", "name": "Dinner Event", "total_estimate": 2000.00, "staff_count": 5, "staff": [ { “staff_id”: staff_12SDfnz29Fam, “cost”: 300 "pay": 70.00, "start": 1427763943, "end": 1429635943 }, {…}, {…}, {…}, {…} ], }

Retrieves the cost estimate details of an existing event. You only need to supply the unique event identifier that was returned upon event creation.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the event to be retrieved.

Response

Returns an event estimate object if a valid identifier was provided, and returns an error otherwise.

Update an Event

DEFINITION

POST https://api.localtable.co/v1/event/{EVENT_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/event/event_14tHpXzLTcWdT91 \ -u auth_api_key:password -h "Content-Type: application/json" { "description": "New event description here." }
    

EXAMPLE RESPONSE

{ "id": "event_BQokikJ0", "ext_id": "12345", "name": "Dinner Event", "venue": "Park Plaza Hotel", "uniform": "Black Pants & White Collard Shirt", "start_date":1414594154, "end_date":1418563479, "description": "New event description here." }

Updates the specified event by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the description

Arguments

Parameter Default Description
ext_id optional: string An external id can be used within a company who maintains their own identifier for a specific event.
name required: string An event name is required and helps describe the event being created.
venue required: LocalTable id A venue is required and dictates where the event will be hosted. The venue is passed using a LocalTable desginated identifier.
uniform required: LocalTable id A uniform is required and dictates what the staff member will be requested to wear. The uniform is passed using a LocalTable desginated identifier.
start_date required: UNIX timestamp The start date is required. It determines the start date and time of an event.
end_date required: UNIX timestamp The end date is required. It determines the end date and time of an event.
description optional: string An event description is optional but recommended as it helps store additional information about an event.

Response

Returns an event object if a valid identifier was provided, and returns an error otherwise.

Shift Method

Create a Shift

DEFINITION

POST https://api.localtable.co/v1/shift

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/uniform \ -u auth_api_key:password -h "Content-Type: application/json" { "event": "event_BQokikJ0", "position": "position_87DmznA120", "no_staff_required": 2 "shift_start": 1414800000, "shift_end": 1414835460 }
    

EXAMPLE RESPONSE

{ "id": "shift_4sZ97acHEAn", "position": "Chef", "no_staff_required": 2, "shift_start": 1414800000, "shift_end": 1414835460, }

This method is used to create a new shift for an already existing event.

Arguments

Parameter Default Description
event required: LocalTable Id An event id is required to assign a shift.
position required: LocalTable Id A position id is required to assign a shift.
no_staff_required required: integer The number of staff required for an event is mandatory.
shift_start required: UNIX timestamp The shift start is required. It determines the start date and time of a shift.
shift_end required: UNIX timestamp The shift end is required. It determines the end date and time of a shift.

Response

Returns a shift object if the shift was created. Returns an error if something goes wrong.

Retrieve a Shift

DEFINITION

GET https://api.localtable.co/v1/shift/{SHIFT_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/shift/shift_4sZ97acHEAn \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "shift_4sZ97acHEAn", "position": "Chef", "no_staff_required": 2, "shift_start": 1414800000, "shift_end": 1414835460, }

Retrieves the details of an existing shift. You only need to supply the unique shift identifier that was returned upon shift creation.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the shift to be retrieved.

Response

Returns a shift object if a valid identifier was provided, and returns an error otherwise.

Update a Shift

DEFINITION

POST https://api.localtable.co/v1/shift/{SHIFT_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/shift/shift_4sZ97acHEAn \ -u auth_api_key:password -h "Content-Type: application/json" { "no_staff_required": 4 }
    

EXAMPLE RESPONSE

{ "id": "shift_4sZ97acHEAn", "position": "Chef", "no_staff_required": 4, "shift_start": 1414800000, "shift_end": 1414835460, }

Updates the specified shift by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Arguments

Parameter Default Description
event required: LocalTable Id An event id is required to assign a shift.
position required: LocalTable Id A position id is required to assign a shift.
no_staff_required required: integer The number of staff required for an event is mandatory.
shift_start required: UNIX timestamp The shift start is required. It determines the start date and time of a shift.
shift_end required: UNIX timestamp The shift end is required. It determines the end date and time of a shift.

Response

Returns a shift object if a valid identifier was provided, and returns an error otherwise.

Delete a Shift

DEFINITION

https://api.localtable.co/v1/shift/{SHIFT_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/shift/shift_4sZ97acHEAn \ -u auth_api_key:password -X DELETE
    

EXAMPLE RESPONSE

{ "id": "shift_4sZ97acHEAn", "deleted": true, }

Permanently deletes an event's shift requirement. It cannot be undone.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the shift to be deleted.

Response

Returns an object with a deleted parameter of success. If the shift has at least 1 staff member assigned to it, this call returns error code: 410 - Can't delete shift because it has staff assigned to it.

Venue Method

Create an Venue

DEFINITION

POST https://api.localtable.co/v1/venue

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/venue \ -u auth_api_key:password -h "Content-Type: application/json" { "name": "Park Plaza Hotel", "building_no": 50, "street": "Park Plaza Road", "city": "Boston", "state": "MA", "zip": "02116", "contact_name": "John Smith", "contact_email": "[email protected]" }
    

EXAMPLE RESPONSE

{ "id": "venue_VAnIz1873kJ0", "name": "Park Plaza Hotel", "building_no":50, "street": "Park Plaza Road", "city": "Boston", "state": "MA", "zip": "02116", "contact_name": "John Smith" "contact_email": "[email protected]" }

This method is used to create a new venue for an authenticated user.

Arguments

Parameter Default Description
name required: string A venue name is required and helps describe the venue being created.
building_no optional: integer A venue's building number is optional but is recommended as it will be listed on all emails and notices for your event.
street optional: string A venue's street address is optional but is recommended as it will be listed on all emails and notices for your event.
city optional: string A venue's city is optional but is recommended as it will be listed on all emails and notices for your event.
state optional: string A venue's state is optional but is recommended as it will be listed on all emails and notices for your event.
zip optional: string A venue's zip is optional but is recommended as it will be listed on all emails and notices for your event.
contact_name optional: string A venue's contact name is optional but is highly recommended as it will be important to contact the event's host
contact_email optional: string A venue's contact email is optional but is highly recommended as it will be important to contact the event's host

Response

Returns a venue object if the venue was created. Returns an error if something goes wrong.

Retrieve a Venue

DEFINITION

GET https://api.localtable.co/v1/venue/{VENUE_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/venue/venue_VAnIz1873kJ0 \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "venue_VAnIz1873kJ0", "name": "Park Plaza Hotel", "building_no":50, "street": "Park Plaza Road", "city": "Boston", "state": "MA", "zip": "02116", "contact_name": "John Smith" "contact_email": "[email protected]" }

Retrieves the details of an existing venue. You only need to supply the unique venue identifier that was returned upon event creation.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the venue to be retrieved.

Response

Returns a venue object if a valid identifier was provided, and returns an error otherwise.

Retrieve all Venues

DEFINITION

GET https://api.localtable.co/v1/venues

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/venue \ -u auth_api_key:password
    

EXAMPLE RESPONSE

[ { "id": "venue_VAnIz1873kJ0", "name": "Park Plaza Hotel", "building_no":50, "street": "Park Plaza Road", "city": "Boston", "state": "MA", "zip": "02116", "contact_name": "John Smith" "contact_email": "[email protected]" }, {...}, {...}, {...} ]

Retrieves the details of all existing venues.

Response

Returns an array of venue objects if object exists, and returns an error otherwise.

Uniform Method

Create a Uniform

DEFINITION

POST https://api.localtable.co/v1/uniform

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/uniform \ -u auth_api_key:password -h "Content-Type: application/json" { "name": "Black Pants & White Collard Shirt" }
    

EXAMPLE RESPONSE

{ "id": "uniform_533sahEJ", "name": "Black Pants & White Collard Shirt", }

This method is used to create a new uniform for an authenticated user.

Arguments

Parameter Default Description
name required: string A uniform name is required and helps the staff assigned to a particular event to dress appropriately.

Response

Returns a uniform object if the uniform was created. Returns an error if something goes wrong.

Retrieve a Uniform

DEFINITION

GET https://api.localtable.co/v1/uniform/{UNIFORM_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/uniform/uniform_533sahEJ \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "uniform_533sahEJ", "name": "Black Pants & White Collard Shirt", }

Retrieves the details of an existing uniform. You only need to supply the unique uniform identifier that was returned upon event creation.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the uniform to be retrieved.

Response

Returns a uniform object if a valid identifier was provided, and returns an error otherwise.

Retrieve all Uniforms

DEFINITION

GET https://api.localtable.co/v1/uniforms

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/uniforms \ -u auth_api_key:password
    

EXAMPLE RESPONSE

[ { "id": "uniform_533sahEJ", "name": "Black Pants & White Collard Shirt", }, {...}, {...}, {...} ]

Retrieves the details of all existing uniforms.

Response

Returns an array of uniform objects if object exists, and returns an error otherwise.

Position Method

Create a Position

DEFINITION

POST https://api.localtable.co/v1/position

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/position \ -u auth_api_key:password -h "Content-Type: application/json" { "name": "Chef" }
    

EXAMPLE RESPONSE

{ "id": "position_87DmznA120", "name": "Chef", }

This method is used to create a new position for an authenticated user.

Arguments

Parameter Default Description
name required: string A position name is required and helps the staff assigned to a particular event know their shift position type.

Response

Returns a uniform object if the uniform was created. Returns an error if something goes wrong.

Retrieve a Position

DEFINITION

GET https://api.localtable.co/v1/position/{POSITION_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/position/position_87DmznA120 \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "position_87DmznA120", "name": "Chef", }

Retrieves the details of an position. You only need to supply the unique position identifier that was returned upon the creation of a position.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the position to be retrieved.

Response

Returns a position object if a valid identifier was provided, and returns an error otherwise.

Assign Staff's Position

DEFINITION

POST https://api.localtable.co/v1//staff/staff_124AcDBhFz/positions

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff/staff_124AcDBhFz/positions \ -u auth_api_key:password -h "Content-Type: application/json" { "position": "position_87DmznA120" "pay_per_hour": 20.00 }
    

EXAMPLE RESPONSE

{ "id": "assignment_mn123Zab7", "name": "Chef", "pay_per_hour": 20.00, }

This method is used to assign a staff to a position for an authenticated user.

Arguments

Parameter Default Description
position required: LocalTable id A position is required.
pay_per_hour optional: decimal The pay per hour is optional but will help when creating payroll reports.

Response

Returns a staff assignment object if the staff assignment was created. Returns an error if something goes wrong.

Retrieve Staff's Position

DEFINITION

GET https://api.localtable.co/v1/staff/staff_124AcDBhFz/positions

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff/staff_124AcDBhFz/positions \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "assignment_mn123Zab7", "name": "Chef", "pay_per_hour": 20.00, {...}, {...}, }

Retrieves the details of all assigned positions per given staff. You only need to supply the unique staff identifier that was returned upon the creation of a staff.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the staff assignment to be retrieved.

Response

Returns a staff assignment object if a valid identifier was provided, and returns an error otherwise.

Staff Method

Create a Staff

DEFINITION

POST https://api.localtable.co/v1/staff

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff \ -u auth_api_key:password -h "Content-Type: application/json" { "first_name": "John", "last_name": "Smith", "email": "[email protected]" , "phone": "555-123-4412" , "dob_month": "Aug" , "dob_day": "29" , "dob_year": "2014" , "address_no": "51" , "address_street": "Melcher Street" , "address_street2": "First Floor" , "address_city": "Boston" , "address_state": "MA" , "address_zip": "02210" , "experience_level": "3" , "ext_staff_id": "SMITH101" , "hours_per_week": 40 }
    

EXAMPLE RESPONSE

{ "id": "staff_124AcDBhFz", "first_name": "John", "last_name": "Smith", "email": "[email protected]", "phone": "555-123-4412", "dob_month": "Aug", "dob_day": "29", "dob_year": "2014", "address_no": "51", "address_street": "Melcher Street", "address_street2": "First Floor", "address_city": "Boston", "adress_state": "MA", "address_zip": "02210, "experience_level": "3", "ext_staff_id": "SMITH101", "hours_per_week": 40, }

This method is used to create a new staff for an authenticated user.

Arguments

Parameter Default Description
first_name required: string A staff's first name is required.
last_name required: string A staff's last name is required.
email required: string A staff's email is required and will be used to notify the staff of all event communications.
phone optional: string A staff's phone number is optional but will help your staffing manager contact your staff.
dob_month optional: string A staff's date of birth month is optional but is useful for basic human resource purposes.
dob_day optional: string A staff's date of birth day is optional but is useful for basic human resource purposes.
dob_year optional: string A staff's date of birth year is optional but is useful for basic human resource purposes.
address_no optional: string A staff's primary residence - house number is optional but is useful for basic human resource and address purposes.
address_street optional: string A staff's primary residence - street address is optional but is useful for basic human resource and address purposes.
address_street2 optional: string A staff's primary residence - secondary street address is optional but is useful for basic human resource and address purposes.
address_city optional: string A staff's primary residence - city is optional but is useful for basic human resource and address purposes.
address_state optional: string A staff's primary residence - state is optional but is useful for basic human resource and address purposes.
address_zip optional: string A staff's primary residence - zip code is optional but is useful for basic human resource and address purposes.
experience_level optional: string A staff's experience level is optional but is useful when selecting staff for an event.
ext_staff_id optional: string A staff's external staff identifier is optional but is useful to tie with external payroll systems.
hours_per_week optional: integer A staff's maximum number of hours per week they can work is optional but is useful when scheduling events.

Response

Returns a staff object if the staff was created. Returns an error if something goes wrong.

Retrieve a Staff

DEFINITION

GET https://api.localtable.co/v1/staff/{STAFF_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff/staff_124AcDBhFz \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "id": "staff_124AcDBhFz", "first_name": "John", "last_name": "Smith", "email": "[email protected]", "phone": "555-123-4412", "dob_month": "Aug", "dob_day": "29", "dob_year": "2014", "address_no": "51", "address_street": "Melcher Street", "address_street2": "First Floor", "address_city": "Boston", "adress_state": "MA", "address_zip": "02210", "experience_level": "3", "ext_staff_id": "SMITH101", "hours_per_week":40, }

Retrieves the details of an existing staff. You only need to supply the unique staff identifier that was returned upon event creation.

Arguments

Parameter Default Description
id required: LocalTable id The identifier of the staff to be retrieved.

Response

Returns a staff object if a valid identifier was provided, and returns an error otherwise.

Retrieve all Staff

DEFINITION

GET https://api.localtable.co/v1/staff

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff \ -u auth_api_key:password
    

EXAMPLE RESPONSE

[ { "id": "staff_124AcDBhFz", "first_name": "John", "last_name": "Smith", "email": "[email protected]", "phone": "555-123-4412", "dob_month": "Aug", "dob_day": "29", "dob_year": "2014", "address_no": "51", "address_street": "Melcher Street", "address_street2": "First Floor", "address_city": "Boston", "adress_state": "MA", "address_zip": "02210", "experience_level": "3", "ext_staff_id": "SMITH101", "hours_per_week":40, }, {...}, {...}, {...} ]

Retrieves details of all existing staff.

Response

Returns an array of staff objects if an object exists, and returns an error otherwise.

Update a Staff

DEFINITION

POST https://api.localtable.co/v1/staff/{STAFF_ID}

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff/staff_124AcDBhFz \ -u auth_api_key:password -h "Content-Type: application/json" { "email": "[email protected]" }
    

EXAMPLE RESPONSE

{ "id": "staff_124AcDBhFz", "first_name": "John", "last_name": "Smith", "email": "[email protected]", "phone": "555-123-4412", "dob_month": "Aug", "dob_day": "29", "dob_year": "2014", "address_no": "51", "address_street": "Melcher Street", "address_street2": "First Floor", "address_city": "Boston", "adress_state": "MA", "address_zip": "02210", "experience_level": "3", "ext_staff_id": "SMITH101", "hours_per_week":40, }

Updates the specified staff by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the description

Arguments

Parameter Default Description
first_name required: string A staff's first name is required.
last_name required: string A staff's last name is required.
email required: string A staff's email is required and will be used to notify the staff of all event communications.
phone optional: string A staff's phone number is optional but will help your staffing manager contact your staff.
dob_month optional: string A staff's date of birth month is optional but is useful for basic human resource purposes.
dob_day optional: string A staff's date of birth day is optional but is useful for basic human resource purposes.
dob_year optional: string A staff's date of birth year is optional but is useful for basic human resource purposes.
address_no optional: string A staff's primary residence - house number is optional but is useful for basic human resource and address purposes.
address_street optional: string A staff's primary residence - street address is optional but is useful for basic human resource and address purposes.
address_street2 optional: string A staff's primary residence - secondary street address is optional but is useful for basic human resource and address purposes.
address_city optional: string A staff's primary residence - city is optional but is useful for basic human resource and address purposes.
address_state optional: string A staff's primary residence - state is optional but is useful for basic human resource and address purposes.
address_zip optional: string A staff's primary residence - zip code is optional but is useful for basic human resource and address purposes.
experience_level optional: string A staff's experience level is optional but is useful when selecting staff for an event.
ext_staff_id optional: string A staff's external staff identifier is optional but is useful to tie with external payroll systems.
hours_per_week optional: integer A staff's maximum number of hours per week they can work is optional but is useful when scheduling events.

Response

Returns a staff object if a valid identifier was provided, and returns an error otherwise.

Actuals Method

Create an Actuals Clock-In Transaction

DEFINITION

POST https://api.localtable.co/v1/staff/staff_124AcDBhFz/clockin

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff/staff_124AcDBhFz/clockin \ -u auth_api_key:password -h "Content-Type: application/json" { "position": "position_87DmznA120", "event": "event_14tHpXzLTcWdT91" }
    

EXAMPLE RESPONSE

{ "id": "staff_124AcDBhFz", "position": "position_87DmznA120", "event": "event_14tHpXzLTcWdT91", "clockin": 1414800000, }

This method is used to clockin a staff member for an authenticated user.

Arguments

Parameter Default Description
staff required: LocalTable id A staff identifier is required to clock-in a staff member.
position required: LocalTable id A position is required to clock-in a staff member.
event required: LocalTable id An event is required to clock-in a staff member.

Response

Returns an actuals clock-in object if the transaction was created. Returns an error if something goes wrong.

Create an Actuals Clock-Out Transaction

DEFINITION

POST https://api.localtable.co/v1/staff/staff_124AcDBhFz/clockout

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff/staff_124AcDBhFz/clockout \ -u auth_api_key:password -h "Content-Type: application/json" { "position": "position_87DmznA120", "event": "event_14tHpXzLTcWdT91" }
    

EXAMPLE RESPONSE

{ "id": "staff_124AcDBhFz", "position": "position_87DmznA120", "event": "event_14tHpXzLTcWdT91", "clockout": 1414835460, }

This method is used to clockout a staff member for an authenticated user.

Arguments

Parameter Default Description
staff required: LocalTable id A staff identifier is required to clock-out a staff member.
position required: LocalTable id A position is required to clock-in a staff member.
event required: LocalTable id An event is required to clock-in a staff member.

Response

Returns an actuals clock-out object if the transaction was created. Returns an error if something goes wrong.

Retrieve all Actuals Transaction

DEFINITION

GET https://api.localtable.co/v1/staff/staff_124AcDBhFz/actuals

EXAMPLE REQUEST

$ curl https://api.localtable.co/v1/staff/staff_124AcDBhFz/actuals \ -u auth_api_key:password
    

EXAMPLE RESPONSE

{ "staff": "staff_124AcDBhFz", "event": "event_BQokikJ0", "clockin": 1414800000, "clockout": 1414835460, {...}, {...}, }

Retrieves the details of an existing staff member's actual hours. You only need to supply the unique staff identifier that was returned upon event creation.

Arguments

Parameter Default Description
staff required: LocalTable id The identifier of the staff actuals to be retrieved.

Response

Returns a uniform object if a valid identifier was provided, and returns an error otherwise.