Skip to main content

Locations

GET List Locations /locations/list

Retrieve all locations accessible by your specific integration.

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 request = axios(rootUrl+`/locations/list`, { 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",
},
{
"id": "location-id-2",
"timezone": "America/Los_Angeles",
"name": "Los Angeles",
"minimumWage": 22,
"address": "123 Street Ave, Los Angeles CA 12345, USA",
"locationEmail": "la@example.com",
}
]