1. Create a position tag
Go to locations_positions_tags in our API documentation and select the POST command.
Fill in the required fields in the input form and click the "Try it!" button on the right.
Endpoint:
POST to:https://shyftplan.com/api/v1/locations_positions_tags
Required fields (must be filled in):
-
company_id→ Your company ID in shyftplan -
user_email→ Your email address (API user) -
authentication_token→ Your API access token -
name→ Name of the tag (e.g., “Prio 1”)
Important:
-
Create each tag individually
-
Note down the ID of each tag from the response (you’ll need it later)
2. Retrieve positions
Go to locations_positions and select the GET command.
Fill in the required fields and submit the request using the "Try It" button.
You will now receive the IDs of all positions at each location — save these for later.
Endpoint:
GET from:https://shyftplan.com/api/v1/locations_positions
Important:
-
Note the IDs of the positions you want to assign tags to.
3. Add position tags to positions
Go back to locations_positions and select the PUT command.
Enter the ID of the position you want to update in the "id" field.
Under tag_ids, enter the ID(s) of the desired tag(s) and send the request.
Endpoint:
PUT to:https://shyftplan.com/api/v1/locations_positions/{id}
Required fields:
-
company_id -
user_email -
authentication_token -
tag_ids→ Add the tag ID(s) as a list
Example:
{
"tag_ids": [123, 456]
}
Note:
-
Always provide all desired tags — existing ones will be overwritten otherwise.
The position tags are now available in your shyftplan account and can be used for prioritization when assigning shifts.