v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

Locations

List Locations

get/v2/company/{company_id}/locations

Path parameters

company_idinteger required

Company ID

Query parameters

modified_sincestring

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

deletedboolean

When TRUE the search will return deleted locations

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

object'locations' required

Example response

{
  "data": [
    {
      "id": 1234,
      "company_id": 1234,
      "name": "Quackers",
      "country": "CA",
      "state": "ON",
      "city": "Toronto",
      "formatted_address": "200 Bathurst Street, Toronto, ON, Canada",
      "lat": 43.6478436,
      "lng": -79.4043708,
      "place_id": "ChIJUyrhFOc0K4gRyuFq6AUlfmE",
      "timezone": "America/Chicago",
      "timezone_updated": true,
      "auto_send_log_book_time": "03:00",
      "sun_is_closed": true,
      "mon_is_closed": true,
      "tue_is_closed": true,
      "wed_is_closed": true,
      "thu_is_closed": true,
      "fri_is_closed": true,
      "sat_is_closed": true,
      "shift_feedback": true,
      "message": "msg",
      "created": "2020-01-01T12:00:00+00:00",
      "modified": "2020-01-02T12:00:00+00:00"
    }
  ]
}