v1/positions/{id}

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

≥ 1

ID of a shyftplan account.

color

string

Color (HEX format, e.g. #FF00FF)

description

string

Description

metadata

string

Position metadata as json

name

string

Name

note

string

Position Comment (Shown on Shift)

sort

int32

Used to order Positions in the UI