Skip to main content

Locations

GET Read Location /locations/read/:id

A location typically reprenset an individual store, building, or seperate restaruant that requires its own set of information.
For example company Byte Kitchen can have 2 locations, one in San Francisco and another in Los Angeles, therefore we can create two location for each one.

Response

NameValueDescriptionRequired
idstringUnique Idtrue
namestringLocation Nametrue
timezonestringTimezone (moment-timezones)false
minimumWagenumberMinimum wage in dollarsfalse
addressstringPhysical Address of the Locationfalse
locationEmailstringEmail Associated with Locationfalse

Authorization Bearer Token

Token                             API_Key

Headers

Content-Type                 application/json

Example

import axios from "axios"; 

const headers = {
"Authorization": `Bearer ${your_api_key}`,
"Content-Type": "application/json"
};

const rootUrl = "https://us-central1-checklist-admin-d0013.cloudfunctions.net/api/v1";

const locationId = "location-id";

const request = axios(rootUrl+`/locations/read/${locationId}`, { headers });

Body Response JSON

	{
"id": "location-id_1",
"timezone": "America/Los_Angeles",
"name": "San Francisco",
"minimumWage": 18,
"address": "123 Street Ave, San Francisco CA 12345, USA",
"locationEmail": "sf@example.com",
}