Shyft Customer > SetupActions API
The Customer > SetupActions API from Shyft — 1 operation(s) for customer > setupactions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/shyft-customer-setupactions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Shyft Customer Customer > SetupActions API
description: Welcome to the Shyft Customer App API.
version: 1.0.0
servers:
- url: http://{{host}}
- url: http://{{local-host}}
- url: http://{{sp3-host}}
- url: http://test-service.myshyft.com
- url: http://localhost:4001
- url: http://localhost:3000
- url: http://{{local-host}}api
- url: https://test-unfurl.myshyft.com
tags:
- name: Customer > SetupActions
paths:
/api/customer/user_role/setup_actions:
get:
tags:
- Customer > SetupActions
summary: '[users] get setup actions'
description: 'All supported actions types:
["action_cancel", "action_update_app", "action_logout", "action_switch_location", "action_update_cache", "action_goto_screen", "action_goto_page", "action_call_api", "action_prompt", "action_sso_logout", "action_restart_app"]
For test purpose, you can supply `sample=true` parameter to get samples actions. Sample actions will not be erased upon visit.
Many actions are user specific.
Meta data only show when supplied the associated `location_id` parameter.'
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: '{{session_uukey}}'
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: location_id
in: query
schema:
type: string
example: '{{sso_lbrand_location_id}}'
- name: local_auth
in: query
schema:
type: boolean
example: 'false'
responses:
'200':
description: 'OK '
headers:
Platform:
schema:
type: string
example: '{{platform}}'
Version:
schema:
type: string
example: '{{version}}'
Build-Number:
schema:
type: string
example: '{{build_number}}'
Push-Id:
schema:
type: string
example: '{{push_id}}'
X-Method:
schema:
type: string
example: '{{x_method}}'
Session-Token:
schema:
type: string
example: '{{session_token}}'
Session-Uukey:
schema:
type: string
example: '{{session_uukey}}'
Authorization:
schema:
type: string
example: Token token={{api_key_access_token}}
Uid:
schema:
type: string
example: '{{uid}}'
Auth-Category:
schema:
type: string
example: '{{auth_category}}'
Auth-Target:
schema:
type: string
example: '{{auth_target}}'
Token-Type:
schema:
type: string
example: Bearer
Client:
schema:
type: string
example: '{{client}}'
Access-Token:
schema:
type: string
example: '{{access_token}}'
Expiry:
schema:
type: string
example: '{{expiry}}'
content:
application/json:
schema:
type: object
example:
setup_actions:
- _parent_object_id: null
id: 28
user_id: null
operation: action_sso_logout
options:
location_id: 2634
url: https://onelogonqa.gap.com/as/authorization.oauth2?response_type=code&redirect_uri=https://test-service.myshyft.com/gap_oauth&client_id=Shyftqa&scope=openid profile&response_mode=form_post
redirect_uri: https://test-service.myshyft.com/gap_oauth
sso_provider_name: sso_gap
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 3
user_id: 9064
operation: action_sso_logout
options:
location_id: 2634
url: https://onelogonqa.gap.com/as/authorization.oauth2?response_type=code&redirect_uri=https://test-service.myshyft.com/gap_oauth&client_id=Shyftqa&scope=openid profile&response_mode=form_post
redirect_uri: https://test-service.myshyft.com/gap_oauth
sso_provider_name: sso_gap
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 30
user_id: 9064
operation: action_tos
options:
tos_url: https://www.myshyft.com/terms-app.html
version: '1.0'
news_id: 100
location_id: 2634
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 2
user_id: 9064
operation: action_logout
options: null
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 10
user_id: 9064
operation: action_prompt
options:
title: page visit
message: choose a button to click
news_id: 1000
icon_url: http://www.google.com
actions:
- id: 9
user_id: 9064
operation: action_call_api
title: button1
options:
url: http://www.google.com/
method: get
body: ''
- id: 9
user_id: 9064
operation: action_call_api
title: button1
options:
url: http://www.google.com/
method: get
body: ''
- id: 9
user_id: 9064
operation: action_call_api
title: button1
options:
url: http://www.google.com/
method: get
body: ''
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 21
user_id: 9064
operation: action_goto_page
options:
url: http://google.com
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 14
user_id: 9064
operation: action_goto_screen
options:
url: screen://user_profile/
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 12
user_id: 9064
operation: action_switch_location
options:
location_id: 1
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 11
user_id: 9064
operation: action_update_cache
options:
location_id: 1
user_id: 1
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: 9
user_id: 9064
operation: action_call_api
options:
url: http://www.google.com/
method: get
body: ''
platform: null
build_start: null
build_end: null
- _parent_object_id: null
id: null
user_id: 9064
operation: action_sso_logout
options:
location_id: 2634
url: https://onelogonqa.gap.com/as/authorization.oauth2?response_type=code&redirect_uri=https://test-service.myshyft.com/gap_oauth&client_id=Shyftqa&scope=openid profile&response_mode=form_post
redirect_uri: https://test-service.myshyft.com/gap_oauth
sso_provider_name: sso_gap
platform: null
build_start: null
build_end: null
meta:
current_user_privilege:
_parent_object_id: null
id: 11044
email: bin@myshyft.com
wage: 15
position: Shyft Assis!
is_approved: true
owner_id: 9064
location_id: 2634
org_id: 1
is_admin: true
read_only: false
first_name: Bin
last_name: Li
phone_number: '18083836511'
profile_image_thumb_url: https://coffeemobile.s3.amazonaws.com/images/thumb/8352_data.?1512600950
location:
_parent_object_id: 11044
id: 2634
swift_code: 6UA3LI
location_name: Gap - 7734
unit_number: null
street_number: null
address: 1 Premium Outlet Blvd
province: MA
postal: '2093'
country: United States
lat: null
lng: null
latitude: 42.0381775
longitude: -71.3524352
phone_number: null
created_at: '2018-01-18T06:33:13.382Z'
users_count: 2
formatted_address: 1 Premium Outlet Blvd, Wrentham, MA 02093, United States
time_zone: null
google_map_id: ChIJx-n2y8Bl5IkRuNonuunKN_c
allow_tipping: true
shift_require_approval: true
shyft_pro_active: true
shyft_pro_expiry_date: '2019-01-18T06:33:13.328Z'
member_count: 2
location_address: null
location_city: WRENTHAM, MA, 2093
division_names:
- Boston
feed_channel_id: 4755
user:
_parent_object_id: 11044
id: 9064
active_org: 0
first_name: Bin
last_name: Li
email: bin@myshyft.com
gender: 0
user_group: 0
profile_image:
thumb_url: https://coffeemobile.s3.amazonaws.com/images/thumb/8352_data.?1512600950
gallery_url: https://coffeemobile.s3.amazonaws.com/images/gallery/8352_data.?1512600950
full_url: https://coffeemobile.s3.amazonaws.com/images/full/8352_data.?1512600950
recent_user_privilege:
_parent_object_id: 9064
id: 10684
email: bin@myshyft.com
wage: 15
position: engineer
is_approved: true
owner_id: 9064
location_id: 1658
org_id: 1
is_admin: true
read_only: false
first_name: Bin
last_name: Li
phone_number: '18083836511'
profile_image_thumb_url: https://coffeemobile.s3.amazonaws.com/images/thumb/8352_data.?1512600950
current_availability: null
location:
_associations_removed: true
_parent_object_id: 10684
id: 1658
swift_code: EGDMIE
location_name: Dog In The Park
unit_number: null
street_number: null
address: 1520 4th Ave
province: WA
postal: '98101'
country: United States
lat: '47.611039'
lng: '-122.337404'
latitude: 47.6108886
longitude: -122.336651
phone_number: null
created_at: '2016-03-13T02:56:14.302Z'
users_count: 5
formatted_address: 1520 4th Ave, Seattle, WA 98101, USA
time_zone: null
google_map_id: ChIJhauVnrRqkFQRhBms88INzM0
allow_tipping: true
shift_require_approval: true
shyft_pro_active: false
shyft_pro_expiry_date: '2018-12-04T19:10:49.425Z'
member_count: 1
location_address: null
location_city: Seattle, WA, 98101
division_names: []
feed_channel_id: 3424
user:
_associations_removed: true
_parent_object_id: 10684
id: 9064
active_org: 0
first_name: Bin
last_name: Li
email: bin@myshyft.com
gender: 0
user_group: 0
current_user:
_parent_object_id: null
id: 9064
active_org: 0
first_name: Bin
last_name: Li
email: bin@myshyft.com
gender: 0
user_group: 0
profile_image:
thumb_url: https://coffeemobile.s3.amazonaws.com/images/thumb/8352_data.?1512600950
gallery_url: https://coffeemobile.s3.amazonaws.com/images/gallery/8352_data.?1512600950
full_url: https://coffeemobile.s3.amazonaws.com/images/full/8352_data.?1512600950
recent_user_privilege:
_parent_object_id: 9064
id: 10684
email: bin@myshyft.com
wage: 15
position: engineer
is_approved: true
owner_id: 9064
location_id: 1658
org_id: 1
is_admin: true
read_only: false
first_name: Bin
last_name: Li
phone_number: '18083836511'
profile_image_thumb_url: https://coffeemobile.s3.amazonaws.com/images/thumb/8352_data.?1512600950
current_availability: null
location:
_parent_object_id: 10684
id: 1658
swift_code: EGDMIE
location_name: Dog In The Park
unit_number: null
street_number: null
address: 1520 4th Ave
province: WA
postal: '98101'
country: United States
lat: '47.611039'
lng: '-122.337404'
latitude: 47.6108886
longitude: -122.336651
phone_number: null
created_at: '2016-03-13T02:56:14.302Z'
users_count: 5
formatted_address: 1520 4th Ave, Seattle, WA 98101, USA
time_zone: null
google_map_id: ChIJhauVnrRqkFQRhBms88INzM0
allow_tipping: true
shift_require_approval: true
shyft_pro_active: false
shyft_pro_expiry_date: '2018-12-04T19:10:49.425Z'
member_count: 1
location_address: null
location_city: Seattle, WA, 98101
division_names: []
feed_channel_id: 3424
user:
_parent_object_id: 10684
id: 9064
active_org: 0
first_name: Bin
last_name: Li
email: bin@myshyft.com
gender: 0
user_group: 0
profile_image:
thumb_url: https://coffeemobile.s3.amazonaws.com/images/thumb/8352_data.?1512600950
gallery_url: https://coffeemobile.s3.amazonaws.com/images/gallery/8352_data.?1512600950
full_url: https://coffeemobile.s3.amazonaws.com/images/full/8352_data.?1512600950
recent_user_privilege:
_associations_removed: true
_parent_object_id: 9064
id: 10684
email: bin@myshyft.com
wage: 15
position: engineer
is_approved: true
owner_id: 9064
location_id: 1658
org_id: 1
is_admin: true
read_only: false
first_name: Bin
last_name: Li
phone_number: '18083836511'
profile_image_thumb_url: https://coffeemobile.s3.amazonaws.com/images/thumb/8352_data.?1512600950
operationId: getApiCustomerUserRoleSetupActions
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
noauthAuth:
type: http
scheme: noauth