Get a template

Returns a single shift template by its numeric id.

GET

/v1/templates/{id}

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

Authorizations

oauth2
templates:read

Parameters

Path Parameters

required

number

Responses

200

A single template

application/json

object

item

required

object

required

integer

>= -9007199254740991 <= 9007199254740991

title

required

string

shortTitle

required

string

notes

string

colorId

required

integer

>= -9007199254740991 <= 9007199254740991

icon

One of:

object
object

object

type

required

string

Allowed values: icon

name

required

string

Allowed values: moon sunrise sun sunset holiday-umbrella

userId

required

integer

>= -9007199254740991 <= 9007199254740991

visibility

required

string

Allowed values: public private hidden

payRateMinor

integer

nullable >= -9007199254740991 <= 9007199254740991

Any of:

object
object

object

allDay

required

boolean

Example

{
  "item": {
    "id": 0,
    "title": "string",
    "shortTitle": "string",
    "notes": "string",
    "colorId": 0,
    "icon": {
      "type": "icon",
      "name": "moon"
    },
    "userId": 0,
    "visibility": "public",
    "payRateMinor": 0,
    "allDay": true
  }
}