List pay-enhancement rules

Returns the authenticated user’s pay-enhancement rules (e.g. weekend or overtime uplifts).

GET

/v1/pay/rules

const url = 'https://api.shiftsync.app/v1/pay/rules';
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.shiftsync.app/v1/pay/rules \
  --header 'Authorization: Bearer <token>'

Authorizations

oauth2
pay:read

Responses

200

The caller’s pay-enhancement rules

application/json

object

items

required

Array<object>

object

required

integer

>= -9007199254740991 <= 9007199254740991

name

required

string

priority

required

integer

>= -9007199254740991 <= 9007199254740991

daysOfWeek

required

Array

startTime

required

string

nullable

endTime

required

string

nullable

kind

required

string

Allowed values: percentage fixed

amount

required

integer

>= -9007199254740991 <= 9007199254740991

enabled

required

boolean

Example

{
  "items": [
    {
      "id": 0,
      "name": "string",
      "priority": 0,
      "daysOfWeek": [
        0
      ],
      "startTime": "string",
      "endTime": "string",
      "kind": "percentage",
      "amount": 0,
      "enabled": true
    }
  ]
}