役割・役職一覧取得

GET

/roles

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/roles';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/roles \
  --header 'Authorization: Bearer <token>'

役割・役職の一覧を取得します。

対象プラン

プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

Authorizations

AppAccessToken
pos.staffs:read
UserAccessToken
pos.staffs:read

Parameters

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

roleId：役割・役職ID
updDateTime：更新日時

limit

integer

上限数

page

integer

ページ

Responses

200

取得成功

application/json

Array<object>

object

roleId

役割・役職ID

string

roleName

役割名・役職名

string

note

説明

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

Example

[
  {
    "roleId": "string",
    "roleName": "string",
    "note": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]