These docs are for v2.2023.0401. Click to read the latest docs for v2.2026.0101.

List Locations

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

Minimum Plan Required: Comp

Sample Response

{
    "data": [
        {
            "id": 4569,
            "company_id": 1234,
            "name": "Pub",
            "country": "CA",
            "state": "SK",
            "city": "Saskatoon",
            "formatted_address": "1234 Street, Saskatoon, SK, Canada",
            "lat": 50,
            "lng": -104,
            "place_id": "ChIJXXXXXXXXXXXXXXXXXXZghg",
            "timezone": "America/Regina",
            "timezone_updated": false,
            "hash": "bc8bxxxxxxxxxxxxxxxxxxxxxxxxx1ca8",
            "mapping_id": "",
            "department_based_budget": true,
            "holiday_pay": true,
            "auto_send_log_book_time": null,
            "mon_hours_close": "00:00:00",
            "tue_hours_close": "00:00:00",
            "wed_hours_close": "00:00:00",
            "thu_hours_close": "00:00:00",
            "fri_hours_close": "00:00:00",
            "sat_hours_close": "00:00:00",
            "sun_hours_close": "00:00:00",
            "mon_hours_open": "07:00:00",
            "tue_hours_open": "08:00:00",
            "wed_hours_open": "08:00:00",
            "thu_hours_open": "08:00:00",
            "fri_hours_open": "08:00:00",
            "sat_hours_open": "08:00:00",
            "sun_hours_open": "07:00:00",
            "mon_is_closed": true,
            "tue_is_closed": false,
            "wed_is_closed": false,
            "thu_is_closed": false,
            "fri_is_closed": false,
            "sat_is_closed": false,
            "sun_is_closed": false,
            "shift_feedback": true,
            "message": "Click here to create a footnote... This is a message that is visible to all employees.",
            "created": "2021-10-19T22:56:48+00:00",
            "modified": "2022-11-25T20:19:23+00:00"
        },
        {
            "id": 4560,
            "company_id": 1234,
            "name": "Cafe",
            "country": "CA",
            "state": "SK",
            "city": "Saskatoon",
            "formatted_address": "1234 Ave, Saskatoon, SK, Canada",
            "lat": 50,
            "lng": -104,
            "place_id": "ChIJXXXXXXXXXXXXXXXXXXZghg",
            "timezone": "America/Regina",
            "timezone_updated": false,
            "hash": "bc8bxxxxxxxxxxxxxxxxxxxxxxxxx1ca8",
            "mapping_id": "",
            "department_based_budget": false,
            "holiday_pay": true,
            "auto_send_log_book_time": null,
            "mon_hours_close": "00:00:00",
            "tue_hours_close": "00:00:00",
            "wed_hours_close": "00:00:00",
            "thu_hours_close": "00:00:00",
            "fri_hours_close": "00:00:00",
            "sat_hours_close": "00:00:00",
            "sun_hours_close": "00:00:00",
            "mon_hours_open": "07:00:00",
            "tue_hours_open": "07:00:00",
            "wed_hours_open": "07:00:00",
            "thu_hours_open": "07:00:00",
            "fri_hours_open": "07:00:00",
            "sat_hours_open": "07:00:00",
            "sun_hours_open": "07:00:00",
            "mon_is_closed": true,
            "tue_is_closed": false,
            "wed_is_closed": false,
            "thu_is_closed": false,
            "fri_is_closed": false,
            "sat_is_closed": false,
            "sun_is_closed": false,
            "shift_feedback": true,
            "message": "Click here to create a footnote... This is a message that is visible to all employees.",
            "created": "2021-10-27T15:25:06+00:00",
            "modified": "2021-10-28T16:39:33+00:00"
        }
    ],
    "meta": {
        "cursor": {
            "current": "eyJsaW1pdCI6Miwib2Zmc2V0IjowfQ==",
            "prev": null,
            "next": "eyJsaW1pdCI6Miwib2Zmc2V0IjoyfQ==",
            "count": 2
        }
    },
    "object": "locations"
}
Path Params
int64
required

Company ID

Query Params
string
^\d{4}-\d{2}-\d{2}$

Return locations that have been modified since the specified date. Format YYYY-MM-DD

boolean
Defaults to false

When TRUE the search will return deleted locations

string

Cursor for the next or previous page of results.

int64
1 to 500
Defaults to 100

The number of results desired per page.

Headers
string
^\d{4}-\d{2}-\d{2}$

7shifts API version

uuid

Company GUID

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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