Shyft Customer > Users > admin_role API
The Customer > Users > admin_role API from Shyft — 2 operation(s) for customer > users > admin_role.
OpenAPI Specification
openapi: 3.0.0
info:
title: Shyft Customer Authentication > Email Customer > Users > admin_role API
description: "Welcome to the Shyft Customer App API.\n\nShyft customer App API is designed to support the function of Shyft Mobile App(iOS, Android), Web App and Manager Dashboard.\n\nNOTES:\n\n- In parameters section, the letter `R` stands for `Required`.\n \n- All API examples show only essential data set.\n \n\n## Authentication\n\n---\n\nInclude as headers for API calls after authentication token.\n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| Session-Uukey | | \\* | The value got from authentication API call (SignIn/Confirm) |\n\n## Global Information\n\n---\n\n#### Query Parameters\n\n###### For All API:\n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| api_version | String | | Ex. 6_0_0 |\n| response\\[nested\\] | Integer | | Ex. 1 |\n| response\\[keep\\] | String | | Ex. location\\[current_user_privilege\\],name,id |\n| response\\[only\\] | String | | Ex. id,location\\[id,location_name,current_user_privilege\\] |\n| response\\[except\\] | String | | Ex. name,location\\[id,location_name,swift_code\\],owner\\[id\\] |\n\n- The query parameter `response[only]` is needed to help API performance by limiting the size of returned data.\n \n- On test server, `response[only]` support wildcard, you can supply `response[only]=\\*` to get everything.\n \n- Production server does not support wildcard, you need to figure out and supply your `response[only]` for each API call.\n \n\n###### For Index API:\n\n- Pagination Option 1)\n \n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| page | Integer | | Ex. 1 |\n| per_page | Integer | | Ex. 5 |\n| total | boolean | | true/false |\n| order | String | | Ex. start_at_desc, start_at_asc |\n\n- Pagination Option 2)\n \n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| limit | Integer | | Ex. 10 |\n| offset | Integer | | Ex. 5 |\n| order | String | | Ex. start_at_desc, start_at_asc |\n| last_id | Integer | | Ex. 101 |\n\n###### For Update API:\n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| response\\[put_return_resource\\] | String | | Ex. true |\n\n#### Headers\n\n| Name | Values | R | Description |\n| --- | --- | --- | --- |\n| Platform | ios|android|web | \\* | |\n| Api-Version | 6_0_0 | \\* | Ex: 6_0_0 |\n| Build-Number | | \\* | |\n| Push-Id | | | |\n| X-Method | | | Deprecated |\n| Content-Type | application/json | \\* | |\n\n#### Success Codes\n\n| SUCCESS Code | Meaning |\n| --- | --- |\n| 200 | Created -- Objet created. |\n| 201 | Unauthorized -- Your API key is wrong. |\n| 204 | No Content -- Success without returning resource. |\n\n#### Error Codes\n\n| Error Code | Meaning |\n| --- | --- |\n| 400 | Bad Request -- Your request is invalid. |\n| 401 | Unauthorized -- Your API key is wrong. |\n| 403 | Forbidden -- The records requested is hidden for administrators only. |\n| 404 | Not Found -- The specified record could not be found. |\n| 405 | Method Not Allowed -- You tried to access a record with an invalid method. |\n| 406 | Not Acceptable -- You requested a format that isn't json. |\n| 410 | Gone -- The record requested has been removed from our servers. |\n| 422 | Unprocessable Entity -- Invalid input data. |\n| 429 | Too Many Requests -- You're requesting too many requests! Slow down! |\n| 500 | Internal Server Error -- We had a problem with our server. Try again later. |\n| 502 | Bad Gateway -- |\n| 504 | Gateway Timeout -- |\n| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |\n\n#### Error Response Formats\n\n422\n\n``` json\n{\n \"errors\": {\n \"base\": [\n \"a private session for same two users already exists: 3034\"\n ]\n }\n}\n\n ```\n\n422\n\n```\n{\n \"errors\": {\n \"google_map_id\": [\n \"can't be blank\"\n ],\n \"time_zone\": [\n \"can't be blank\"\n ],\n \"longitude\": [\n \"can't be blank\"\n ]\n }\n}\n{\n \"errors\": {\n \"record_invalid\": [\n \"Validation failed: User has already been taken\"\n ]\n }\n}\n\n ```\n\n404\n\n``` json\n{\n \"errors\": {\n \"not_found\": [\n \"Couldn't find Post\"\n ]\n }\n}\n\n ```\n\n500\n\n``` json\n{\n \"errors\": {\n \"internal_server_error\": [\n \"Invalid nil value\"\n ]\n }\n}\n\n ```"
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 > Users > admin_role
paths:
/api/customer/admin_role/locations/{location_id}/users:
get:
tags:
- Customer > Users > admin_role
summary: '[users] get members of specific location'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: Session-Token
in: header
schema:
type: string
description: '[MESSION] session token ID. deprecate it soon.'
example: '{{session_token}}'
- name: Session-Uukey
in: header
schema:
type: string
description: '[MESSION] session token UUID. replace `session-token`
'
example: '{{session_uukey}}'
- name: Authorization
in: header
schema:
type: string
description: '[MESSION] api key, preset inside app, not secure
'
example: Token token={{api_key_access_token}}
- name: location_id
in: path
schema:
type: string
required: true
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:
users:
- id: 86341
active_org: 0
first_name: Maylee
last_name: Correa
email: 14074592803@coffeemobile.com
gender: 0
chat_handle: 0c9e249f42ba156eede3722240b5dde9
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
profile_image:
thumb_url: https://coffeemobile.s3.amazonaws.com/images/thumb/295499_86341-20180410_133756_229.jpg?1523381877
gallery_url: https://coffeemobile.s3.amazonaws.com/images/gallery/295499_86341-20180410_133756_229.jpg?1523381877
full_url: https://coffeemobile.s3.amazonaws.com/images/full/295499_86341-20180410_133756_229.jpg?1523381877
current_open_availability_request:
id: 140
user_id: 191772
location_id: 49603
is_active: true
closed: false
notes: ''
users_count: 46
submitters_count: 28
availabilities:
- id: 1159
status: pending
notes: null
user_id: 195127
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-16T16:37:13.033Z'
sunday:
_associations_removed: true
start_at: 08:00
end_at: '22:00'
monday:
_associations_removed: true
start_at: 06:00
end_at: '23:00'
tuesday:
_associations_removed: true
start_at: 06:00
end_at: '23:00'
wednesday:
_associations_removed: true
start_at: 06:00
end_at: '23:00'
thursday:
_associations_removed: true
start_at: 06:00
end_at: '23:00'
friday:
_associations_removed: true
start_at: 06:00
end_at: '23:00'
saturday:
_associations_removed: true
start_at: 06:00
end_at: '23:00'
user:
_associations_removed: true
id: 195127
active_org: 0
first_name: Shannon
last_name: Burr
email: 17176140312@coffeemobile.com
gender: 0
chat_handle: 8ab90fad9f7612912b18bcdbc004c269
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 1215
status: pending
notes: null
user_id: 194298
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-17T01:35:36.316Z'
sunday:
_associations_removed: true
start_at: null
end_at: null
monday:
_associations_removed: true
start_at: 06:00
end_at: '10:00'
tuesday:
_associations_removed: true
start_at: null
end_at: null
wednesday:
_associations_removed: true
start_at: 06:00
end_at: '10:00'
thursday:
_associations_removed: true
start_at: null
end_at: null
friday:
_associations_removed: true
start_at: null
end_at: null
saturday:
_associations_removed: true
start_at: 08:00
end_at: '12:00'
user:
_associations_removed: true
id: 194298
active_org: 0
first_name: 'Emilee '
last_name: 'Maugans '
email: 17179434798@coffeemobile.com
gender: 0
chat_handle: da7f3be92283267160aab3a5e5e76c15
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 1216
status: pending
notes: null
user_id: 194762
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-17T01:53:58.487Z'
sunday:
_associations_removed: true
start_at: '14:00'
end_at: '21:00'
monday:
_associations_removed: true
start_at: '18:00'
end_at: '22:30'
tuesday:
_associations_removed: true
start_at: '18:00'
end_at: '22:30'
wednesday:
_associations_removed: true
start_at: null
end_at: null
thursday:
_associations_removed: true
start_at: '18:00'
end_at: '22:30'
friday:
_associations_removed: true
start_at: '18:00'
end_at: '22:30'
saturday:
_associations_removed: true
start_at: null
end_at: null
user:
_associations_removed: true
id: 194762
active_org: 0
first_name: Andrea
last_name: Repetz
email: 17178107593@coffeemobile.com
gender: 0
chat_handle: 16d0af9863b71b82e693261d2547a04f
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 670
status: pending
notes: null
user_id: 193043
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T22:06:18.660Z'
sunday:
_associations_removed: true
start_at: null
end_at: null
monday:
_associations_removed: true
start_at: null
end_at: null
tuesday:
_associations_removed: true
start_at: '18:00'
end_at: '22:30'
wednesday:
_associations_removed: true
start_at: '18:00'
end_at: '22:30'
thursday:
_associations_removed: true
start_at: null
end_at: null
friday:
_associations_removed: true
start_at: null
end_at: null
saturday:
_associations_removed: true
start_at: null
end_at: null
user:
_associations_removed: true
id: 193043
active_org: 0
first_name: 'Sharlene '
last_name: Rodriguez
email: 12158473492@coffeemobile.com
gender: 0
chat_handle: ac6b43127f6426e7596a7c5f447b1d78
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 671
status: pending
notes: null
user_id: 191772
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T22:06:26.254Z'
sunday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
monday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
tuesday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
wednesday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
thursday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
friday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
saturday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
user:
_associations_removed: true
id: 191772
active_org: 1
first_name: Kate
last_name: 'Kennedy '
email: kate_kennedy@stores.gap.com
gender: 0
chat_handle: fba9b6b7fe9d3f1c3c97e9a96b7e0093
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 673
status: pending
notes: null
user_id: 192445
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T22:08:36.432Z'
sunday:
_associations_removed: true
start_at: 05:00
end_at: '23:30'
monday:
_associations_removed: true
start_at: '18:00'
end_at: '23:00'
tuesday:
_associations_removed: true
start_at: '18:00'
end_at: '23:00'
wednesday:
_associations_removed: true
start_at: '18:00'
end_at: '23:00'
thursday:
_associations_removed: true
start_at: '18:00'
end_at: '23:00'
friday:
_associations_removed: true
start_at: '18:00'
end_at: '23:00'
saturday:
_associations_removed: true
start_at: null
end_at: null
user:
_associations_removed: true
id: 192445
active_org: 0
first_name: Katie
last_name: Toole
email: 17744889183@coffeemobile.com
gender: 0
chat_handle: 33c3fec9e6a6f73de78f255cb7ffd98b
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 677
status: pending
notes: null
user_id: 192637
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T22:26:29.619Z'
sunday:
_associations_removed: true
start_at: 08:00
end_at: 00:00
monday:
_associations_removed: true
start_at: 08:00
end_at: 00:00
tuesday:
_associations_removed: true
start_at: 08:00
end_at: 00:00
wednesday:
_associations_removed: true
start_at: 08:00
end_at: 00:00
thursday:
_associations_removed: true
start_at: 08:00
end_at: 00:00
friday:
_associations_removed: true
start_at: 08:00
end_at: 00:00
saturday:
_associations_removed: true
start_at: 08:00
end_at: 00:00
user:
_associations_removed: true
id: 192637
active_org: 0
first_name: Tussonie
last_name: Hand
email: tussonie_hand@stores.gap.com
gender: 0
chat_handle: 5e64d92f6379a5e2681c4a230997d0c8
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 679
status: pending
notes: null
user_id: 192904
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T22:31:48.350Z'
sunday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
monday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
tuesday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
wednesday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
thursday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
friday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
saturday:
_associations_removed: true
start_at: 00:00
end_at: '23:59'
user:
_associations_removed: true
id: 192904
active_org: 0
first_name: Kat
last_name: Ratliff
email: 13175255723@coffeemobile.com
gender: 0
chat_handle: 95484192695fd1e2398ce9bada3c3985
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 685
status: pending
notes: null
user_id: 192096
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T23:09:17.452Z'
sunday:
_associations_removed: true
start_at: 00:00
end_at: '12:00'
monday:
_associations_removed: true
start_at: null
end_at: null
tuesday:
_associations_removed: true
start_at: null
end_at: null
wednesday:
_associations_removed: true
start_at: null
end_at: null
thursday:
_associations_removed: true
start_at: '18:00'
end_at: '23:00'
friday:
_associations_removed: true
start_at: '18:00'
end_at: '23:00'
saturday:
_associations_removed: true
start_at: 00:00
end_at: '12:00'
user:
_associations_removed: true
id: 192096
active_org: 0
first_name: Sara
last_name: Swinnich
email: 17178391665@coffeemobile.com
gender: 0
chat_handle: 9f4fb2f7e4babb11014ca7f8d221be3c
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 687
status: pending
notes: null
user_id: 193346
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T23:30:44.404Z'
sunday:
_associations_removed: true
start_at: null
end_at: null
monday:
_associations_removed: true
start_at: 09:30
end_at: '14:00'
tuesday:
_associations_removed: true
start_at: 09:30
end_at: '14:00'
wednesday:
_associations_removed: true
start_at: 09:30
end_at: '14:00'
thursday:
_associations_removed: true
start_at: 09:30
end_at: '14:00'
friday:
_associations_removed: true
start_at: 09:30
end_at: '14:00'
saturday:
_associations_removed: true
start_at: null
end_at: null
user:
_associations_removed: true
id: 193346
active_org: 0
first_name: Ashli
last_name: Daley
email: 17175797463@coffeemobile.com
gender: 0
chat_handle: 6247da6a502975711fdf9bc6fa63702a
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 689
status: pending
notes: null
user_id: 192616
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T23:49:52.506Z'
sunday:
_associations_removed: true
start_at: 06:00
end_at: '11:00'
monday:
_associations_removed: true
start_at: null
end_at: null
tuesday:
_associations_removed: true
start_at: null
end_at: null
wednesday:
_associations_removed: true
start_at: null
end_at: null
thursday:
_associations_removed: true
start_at: null
end_at: null
friday:
_associations_removed: true
start_at: 06:00
end_at: '10:30'
saturday:
_associations_removed: true
start_at: null
end_at: null
user:
_associations_removed: true
id: 192616
active_org: 0
first_name: Tori
last_name: White
email: 17175852464@coffeemobile.com
gender: 0
chat_handle: 9cb8fe2446cd05691fd1d7caca7db5d0
user_group: 0
status: ''
current_open_availability_request_submit_status: submitted
- id: 690
status: pending
notes: null
user_id: 191921
location_id: 49603
availability_request_id: 140
updated_at: '2018-04-10T23:56:29.151Z'
sunday:
_associations_removed: true
start_at: '10:00'
end_at: '20:30'
monday:
_associations_removed: true
start_at: '14:30'
end_at: '20:30'
tuesday:
_associations_removed: true
start_at: '14:30'
end_at: '20:30'
wednesday:
_associations_removed: true
start_at: '14:30'
end_at: '20:30'
thursday:
_associations_removed: true
start_at: '14:30'
end_at: '20:30'
friday:
_associations_removed: true
start_at: '14:30'
end_at: '22:30'
saturday:
_associations_removed: true
start_at: '10:00'
end_at: '22:30'
user:
_associations_removed: true
id: 191921
active_org: 0
first_name: Hailey
last_name: Rosbach
email: 17179030065@coffeemobile.com
gender: 0
# --- truncated at 32 KB (3248 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shyft/refs/heads/main/openapi/shyft-customer-users-admin-role-api-openapi.yml