コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

事業所一覧取得

GET
/stores

事業所一覧を取得します

対象

  • プラン
    • スタンダード、旧無料
    • プレミアム
    • プレミアムプラス
    • エンタープライズ、旧有料

対象ユーザー権限

  • 事業所管理閲覧

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
display_flag
number
0
Allowed values: 0 1

非表示事業所を含めて表示するかどうか

  • 0: 表示しない
  • 1: 表示する
Example
1
store_name
string

事業所名

Example
スマレジ本社
limit
integer
default: 30 >= 1 <= 100

上限値

Example
50
page
integer
default: 1 >= 1

検索対象ページ番号

Example
2
sort
string

ソート順
パラメータ名で昇順、パラメータ名:descで降順指定可 カンマ区切りで複数項目指定可

Example
?sort=store_name%3Adesc%2Cstore_id

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

object
count

件数

number
page

現在のページ番号

number
pageCount

総ページ数

number
stores

事業所データリスト

Array<object>
object
storeId

事業所ID

string
storeName

事業所名

string
storeAbbr

事業所名略称

string
storeKana

事業所名フリガナ

string
postCode

郵便番号

string
address

住所

string
prefectureCode

都道府県コード

string
phone

電話番号

string
mail

メールアドレス

string
autoBreakTimeDivision

休憩時間自動設定区分

  • 1: 時間指定
  • 2: 条件指定
string
Allowed values: 1 2
autoBreakStartTime1

自動休憩（時間指定） 休憩1 開始時刻 [hh:mm:ss]

string format: time
autoBreakEndTime1

自動休憩（時間指定） 休憩1 終了時刻 [hh:mm:ss]

string format: time
autoBreakStartTime2

自動休憩（時間指定） 休憩2 開始時刻 [hh:mm:ss]

string format: time
autoBreakEndTime2

自動休憩（時間指定） 休憩2 終了時刻 [hh:mm:ss]

string format: time
autoBreakCondition1Division

自動休憩（条件指定） 設定方法1

  • 1: 出勤後に追加
  • 2: 退勤前に追加
  • 3: 中央に追加
  • 4: 通常労働優先
  • 5: 深夜労働優先
string
Allowed values: 1 2 3 4 5
autoBreakCondition1ConditionTime

自動休憩（条件指定） 勤務時間条件1（分以上）

string
autoBreakCondition1SettingTime

自動休憩（条件指定） 休憩時間1（分）

string
autoBreakCondition2Division

自動休憩（条件指定） 設定方法2

  • 1: 出勤後に追加
  • 2: 退勤前に追加
  • 3: 中央に追加
  • 4: 通常労働優先
  • 5: 深夜労働優先
string
Allowed values: 1 2 3 4 5
autoBreakCondition2ConditionTime

自動休憩（条件指定） 勤務時間条件2（分以上）

string
autoBreakCondition2SettingTime

自動休憩（条件指定） 休憩時間2（分）

string
autoBreakCondition3Division

自動休憩（条件指定） 設定方法3

  • 1: 出勤後に追加
  • 2: 退勤前に追加
  • 3: 中央に追加
  • 4: 通常労働優先
  • 5: 深夜労働優先
string
Allowed values: 1 2 3 4 5
autoBreakCondition3ConditionTime

自動休憩（条件指定） 勤務時間条件3（分以上）

string
autoBreakCondition3SettingTime

自動休憩（条件指定） 休憩時間3（分）

string
roundSetting

シフト管理単位設定

  • 0: かんたん設定
  • 1: 詳細設定

従業員が打刻を行なった際に、打刻した時刻を設定した範囲で丸めを行なうための設定です。

string
Allowed values: 0 1
attendanceScheduleRoundDivision

シフト丸め設定（出勤）

  • 0: 丸めない
  • 1: 丸める
  • 2: 打刻実績のみ丸める
string
Allowed values: 0 1 2
attendanceScheduleRoundUnit

シフト丸め単位（出勤）

  • 1: 1分
  • 5: 5分
  • 10: 10分
  • 15: 15分
  • 20: 20分
  • 30: 30分
  • 60: 60分
string
Allowed values: 1 5 10 15 20 30 60
attendanceShiftUnit

シフト管理単位（詳細設定）
状態: 出勤 管理単位（分）

  • 1: 1分
  • 5: 5分
  • 10: 10分
  • 15: 15分
  • 20: 20分
  • 30: 30分
  • 60: 60分
string
Allowed values: 1 5 10 15 20 30 60
attendanceRound

シフト管理単位（詳細設定）
状態: 出勤 計算方法

  • 0: 切上げ
  • 1: 切捨て
string
Allowed values: 0 1
leavingScheduleRoundDivision

シフト丸め設定（退勤）

  • 0: 丸めない
  • 1: 丸める
  • 2: 打刻実績のみ丸める
string
Allowed values: 0 1 2
leavingScheduleRoundUnit

シフト丸め単位（退勤）

  • 1: 1分
  • 5: 5分
  • 10: 10分
  • 15: 15分
  • 20: 20分
  • 30: 30分
  • 60: 60分
string
Allowed values: 1 5 10 15 20 30 60
leavingShiftUnit

シフト管理単位（詳細設定）
状態: 退勤 管理単位（分）

  • 1: 1分
  • 5: 5分
  • 10: 10分
  • 15: 15分
  • 20: 20分
  • 30: 30分
  • 60: 60分
string
Allowed values: 1 5 10 15 20 30 60
leavingRound

シフト管理単位（詳細設定）
状態: 退勤 計算方法

  • 0: 切上げ
  • 1: 切捨て
string
Allowed values: 0 1
breakStartShiftUnit

シフト管理単位（詳細設定）
状態: 休憩開始 管理単位（分）

  • 1: 1分
  • 5: 5分
  • 10: 10分
  • 15: 15分
  • 20: 20分
  • 30: 30分
  • 60: 60分
string
Allowed values: 1 5 10 15 20 30 60
breakStartRound

シフト管理単位（詳細設定）
状態: 休憩開始 計算方法

  • 0: 切上げ
  • 1: 切捨て
string
Allowed values: 0 1
breakEndShiftUnit

シフト管理単位（詳細設定）
状態: 休憩終了 管理単位（分）

  • 1: 1分
  • 5: 5分
  • 10: 10分
  • 15: 15分
  • 20: 20分
  • 30: 30分
  • 60: 60分
string
Allowed values: 1 5 10 15 20 30 60
breakEndRound

シフト管理単位（詳細設定）
状態: 休憩終了 計算方法

  • 0: 切上げ
  • 1: 切捨て
string
Allowed values: 0 1
businessDayStart

日付変更時間 [hh:mm:ss]

string format: time
closingDay

締め日

string
displaySequence

表示順

string
displayFlag

事業所表示設定

  • 0: 表示しない
  • 1: 表示する
string
Allowed values: 0 1
passCodeSetting

出退勤パスコード設定

  • 0: 使用しない
  • 1: 使用する
string
Allowed values: 0 1
requireLocation

位置情報必須設定（Web出退勤画面）

  • 0: 任意
  • 1: 必須
string
Allowed values: 0 1
requireLocationApp

位置情報必須設定（アプリ）

  • 0: 任意
  • 1: 必須
string
Allowed values: 0 1
geoFencingEnabled

ジオフェンシング打刻設定
※契約中のプランがジオフェンシング打刻を利用できない場合は値によらずジオフェンシング打刻は無効です。

  • 0: 使用しない
  • 1: 使用する
string
Allowed values: 0 1
geoFencingLatitude

ジオフェンシング打刻緯度

number format: double
>= -90 <= 90
geoFencingLongitude

ジオフェンシング打刻経度

number format: double
>= -180 <= 180
geoFencingRadius

ジオフェンシング打刻半径(m)

number format: integer
>= 1 <= 500
requirePicture

写真撮影必須設定（Web出退勤画面）

  • 0: 任意
  • 1: 必須
string
Allowed values: 0 1
requirePictureApp

写真撮影必須設定（アプリ）

  • 0: 任意
  • 1: 必須
string
Allowed values: 0 1
Example
{
  "count": 2,
  "page": 1,
  "pageCount": 1,
  "stores": [
    {
      "storeId": "1",
      "storeName": "スマレジ本社",
      "storeAbbr": "本社",
      "storeKana": "スマレジホンシャ",
      "postCode": "540-0029",
      "address": "大阪府大阪市中央区本町4-2-12",
      "prefectureCode": "27",
      "phone": "06-6267-6007",
      "mail": "info@smaregi.jp",
      "autoBreakTimeDivision": "1",
      "autoBreakStartTime1": "12:00:00",
      "autoBreakEndTime1": "13:00:00",
      "autoBreakStartTime2": "15:00:00",
      "autoBreakEndTime2": "15:15:00",
      "autoBreakCondition1Division": "3",
      "autoBreakCondition1ConditionTime": "360",
      "autoBreakCondition1SettingTime": "60",
      "autoBreakCondition2Division": "1",
      "autoBreakCondition2ConditionTime": "480",
      "autoBreakCondition2SettingTime": "15",
      "autoBreakCondition3Division": "1",
      "autoBreakCondition3ConditionTime": "600",
      "autoBreakCondition3SettingTime": "30",
      "roundSetting": "1",
      "attendanceScheduleRoundDivision": "1",
      "attendanceScheduleRoundUnit": "15",
      "attendanceShiftUnit": "15",
      "attendanceRound": "1",
      "leavingScheduleRoundDivision": "1",
      "leavingScheduleRoundUnit": "15",
      "leavingShiftUnit": "15",
      "leavingRound": "0",
      "breakStartShiftUnit": "15",
      "breakStartRound": "1",
      "breakEndShiftUnit": "15",
      "breakEndRound": "0",
      "businessDayStart": "05:00:00",
      "closingDay": "25",
      "displaySequence": "1",
      "displayFlag": "1",
      "passCodeSetting": "1",
      "requireLocation": "1",
      "requireLocationApp": "1",
      "geoFencingEnabled": "1",
      "geoFencingLatitude": 34.684206,
      "geoFencingLongitude": 135.507926,
      "geoFencingRadius": 100,
      "requirePicture": "0",
      "requirePictureApp": "1"
    },
    {
      "storeId": "2",
      "storeName": "スマレジ大阪店",
      "storeAbbr": "大阪店",
      "storeKana": "スマレジオオサカテン",
      "postCode": "530-0001",
      "address": "大阪府大阪市北区梅田1-1-1",
      "prefectureCode": "27",
      "phone": "06-1234-5678",
      "mail": "osaka@smaregi.jp",
      "autoBreakTimeDivision": "2",
      "autoBreakStartTime1": "",
      "autoBreakEndTime1": "",
      "autoBreakStartTime2": "",
      "autoBreakEndTime2": "",
      "autoBreakCondition1Division": "4",
      "autoBreakCondition1ConditionTime": "360",
      "autoBreakCondition1SettingTime": "45",
      "autoBreakCondition2Division": "1",
      "autoBreakCondition2ConditionTime": "480",
      "autoBreakCondition2SettingTime": "15",
      "autoBreakCondition3Division": "1",
      "autoBreakCondition3ConditionTime": "",
      "autoBreakCondition3SettingTime": "",
      "roundSetting": "0",
      "attendanceScheduleRoundDivision": "0",
      "attendanceScheduleRoundUnit": "1",
      "attendanceShiftUnit": "1",
      "attendanceRound": "1",
      "leavingScheduleRoundDivision": "0",
      "leavingScheduleRoundUnit": "1",
      "leavingShiftUnit": "1",
      "leavingRound": "1",
      "breakStartShiftUnit": "1",
      "breakStartRound": "1",
      "breakEndShiftUnit": "1",
      "breakEndRound": "1",
      "businessDayStart": "00:00:00",
      "closingDay": "31",
      "displaySequence": "2",
      "displayFlag": "1",
      "passCodeSetting": "0",
      "requireLocation": "0",
      "requireLocationApp": "0",
      "geoFencingEnabled": "0",
      "geoFencingLatitude": 0,
      "geoFencingLongitude": 0,
      "geoFencingRadius": 1,
      "requirePicture": "0",
      "requirePictureApp": "0"
    }
  ]
}

Headers

Section titled “Headers ”
Link
string

<前のURI>; rel="prev", <次のURI>; rel="next"

400

Section titled “400 ”

パラメータに誤りがある場合

object
type

エラータイプを識別するURI、もしくはabout:blank

string
title

エラーの概要

string
detail

エラーの詳細

string
Example
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "表示非表示フラグの指定は0か1で行なってください"
}