Shyft Compact > UserPrivileges API
The Compact > UserPrivileges API from Shyft — 1 operation(s) for compact > userprivileges.
OpenAPI Specification
openapi: 3.0.0
info:
title: Shyft Customer Authentication > Email Compact > UserPrivileges 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: Compact > UserPrivileges
paths:
/api/compact/user_privileges/ui_dash_user_management:
get:
tags:
- Compact > UserPrivileges
summary: 'UI API: Dash User Managements'
description: "Description\n- - - \nGet the job status by giving a `request_job` ID.\n\nIt will return the result of Job processed at background. For example, the API result for a `bulk_create` API called with `async_mode=true`\n\nParams\n- - -\nParam | Values | R | Description\n--- | --- | --- | ---\n\n\nHeaders\n- - -\nHeader | Values | R |Description\n--- | --- | --- | ---\n\nInput\n- - - \n\nAttribute | Values | R |Description\n--- | --- | --- | ---\nrequest_job_id | | * | The `request_job` ID got from other API procesed under `async_mode=true`"
parameters:
- name: Session-Uukey
in: header
schema:
type: string
example: 6832e665-4721-47f2-a65d-af7be9a16565
- name: response[put_return_resource]
in: query
schema:
type: boolean
example: 'true'
- name: response[nested]
in: query
schema:
type: integer
example: '2'
- name: response[only]
in: query
schema:
type: string
example: owner_id,id,is_admin,first_name,last_name,position,status,profile_image_thumb_url,deleted_at,department_ids,badge_id,email,phone_number,user[skill_ids,],
- name: total
in: query
schema:
type: boolean
example: 'true'
- name: page
in: query
schema:
type: integer
example: '2'
- name: per_page
in: query
schema:
type: integer
example: '1000'
- name: location_id
in: query
schema:
type: integer
example: '2806'
- name: with_deleted
in: query
schema:
type: boolean
example: 'true'
responses:
'200':
description: OK
headers:
X-Frame-Options:
schema:
type: string
example: SAMEORIGIN
X-XSS-Protection:
schema:
type: string
example: 1; mode=block
X-Content-Type-Options:
schema:
type: string
example: nosniff
X-Download-Options:
schema:
type: string
example: noopen
X-Permitted-Cross-Domain-Policies:
schema:
type: string
example: none
Referrer-Policy:
schema:
type: string
example: strict-origin-when-cross-origin
X-LS-License:
schema:
type: string
example: All Rights Reserved © Coffee Enterprise
X-LS-Application:
schema:
type: string
example: Coffee Mobile
X-Request-Method:
schema:
type: string
example: none
Content-Type:
schema:
type: string
example: application/json; charset=utf-8
ETag:
schema:
type: string
example: W/"04f6d9c05ed7e61c2291144eac21d9f5"
Cache-Control:
schema:
type: string
example: max-age=0, private, must-revalidate
Set-Cookie:
schema:
type: string
example: _shyft_api_server_session=aFQ4djBqQStUa2dxNnhFN0pqNXFSazBlTHhlM2ZoUGo1NDZyVWVuNU40SGdMUnVhQjlJckxhaUdqVHViZWdnWFpGRGVHT1NRN1A1a2N0bXhFUnZ1Vmc9PS0tZUM2V1h1MHBicEhxK0hsZVZFRlhTZz09--dee3339207af6bc35b4a05a0512bea64b1446717; path=/; HttpOnly
X-Rack-Dev-Mark-Env:
schema:
type: string
example: BinLocalServer
X-Request-Id:
schema:
type: string
example: 47ced12a-1d54-476e-9eda-426ee33ad166
X-Runtime:
schema:
type: number
example: '9.639663'
Vary:
schema:
type: string
example: Origin
Transfer-Encoding:
schema:
type: string
example: chunked
content:
application/json:
schema:
type: object
example:
user_privileges:
- _parent_object_id: null
id: 23895
email: null
position: null
badge_id: null
owner_id: 11773
first_name: Leonardo
last_name: V6Android
phone_number: '18887771111'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids:
- 13
user:
_parent_object_id: 23895
id: 11773
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 11369
- 10619
- 8199
- 7928
- 8034
- 8030
- 8027
- 8025
- 8035
- 8033
- 8026
- 8023
- 8022
- 8036
- 8031
- 8021
- 8029
- 8020
- 8028
- 8024
- 8019
- 8018
- 8037
- 8032
- 8016
- 8014
- 8013
- 8011
- 8009
- 8017
- 8012
- 8015
- 8006
- 8005
- 7971
- 7970
- 7967
- 7965
- 7972
- 7966
- 7962
- 7960
- 7964
- 7974
- 7968
- 7963
- 8004
- 7973
- 7969
- 7949
- 7946
- 7947
- 7948
- 7944
- 7945
- 7943
- 7961
- 8044
- 8043
- 8042
- 8040
- 8038
- 8041
- 8039
- 8195
- _parent_object_id: null
id: 23818
email: null
position: null
badge_id: null
owner_id: 12217
first_name: Leslie
last_name: Knope
phone_number: '18888884011'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/10154_12217-20190701_153051_544.jpg?1562020251
status: active
department_ids: []
user:
_parent_object_id: 23818
id: 12217
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 8372
- 10619
- 7928
- 8373
- 8375
- 8374
- 8367
- 7577
- 3520
- 7385
- _parent_object_id: null
id: 23798
email: null
position: null
badge_id: null
owner_id: 12064
first_name: Lex
last_name: Murphy
phone_number: '18888889003'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/9874_12064-20190422_170233_770.jpg?1555977754
status: active
department_ids: []
user:
_parent_object_id: 23798
id: 12064
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 10619
- 8297
- 7928
- _parent_object_id: null
id: 24248
email: null
position: null
badge_id: null
owner_id: 8136
first_name: Lexus
last_name: Luther
phone_number: '18008888963'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 24248
id: 8136
skill_ids: []
channel_ids:
- 4927
- 7613
- 11369
- 3984
- 3518
- _parent_object_id: null
id: 23571
email: null
position: Test10
badge_id: '55874'
owner_id: 15899
first_name: Light
last_name: Light
phone_number: '17777777710'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/21140_15899-20230818_162134_495.jpg?1692400895
status: active
department_ids: []
user:
_parent_object_id: 23571
id: 15899
skill_ids: []
channel_ids:
- 13863
- 12457
- 4927
- 7613
- _parent_object_id: null
id: 24334
email: steve@qaonrequest.com
position: null
badge_id: null
owner_id: 8091
first_name: Lina
last_name: Rimiss
phone_number: '18008888938'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/7261_3810-20170110_175954_758.jpg?1484089197
status: active
department_ids: []
user:
_parent_object_id: 24334
id: 8091
skill_ids: []
channel_ids:
- 4927
- 7613
- 3984
- 3733
- 3738
- 3729
- 3721
- 3720
- 3727
- 3724
- 3719
- _parent_object_id: null
id: 20666
email: null
position: Retail Associate
badge_id: null
owner_id: 14217
first_name: Linda
last_name: Adams
phone_number: '18889991039'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/15386_file.png?1608155807
status: active
department_ids: []
user:
_parent_object_id: 20666
id: 14217
skill_ids: []
channel_ids:
- 13863
- 12457
- 12488
- 4927
- 7613
- _parent_object_id: null
id: 23691
email: molly@myshyft.com
position: null
badge_id: null
owner_id: 11681
first_name: Lindi
last_name: Limmerick
phone_number: '18888881386'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/9568_cropped2019-02-24T001642.422Z.jpg?1550967432
status: active
department_ids: []
user:
_parent_object_id: 23691
id: 11681
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 7928
- 10688
- 10619
- 8199
- 8041
- 8195
- 8040
- 8038
- 8034
- 7974
- 7967
- 8033
- 8039
- 8026
- 8035
- 8025
- 8031
- 8023
- 8029
- 7963
- 8027
- 8021
- 8028
- 8020
- 8032
- 8018
- 7973
- 8012
- 8022
- 8004
- 8024
- 8014
- 8017
- 7966
- 8016
- 8030
- 8013
- 8015
- 8011
- _parent_object_id: null
id: 23950
email: steve+linkin@myshyft.com
position: null
badge_id: null
owner_id: 10086
first_name: Linking
last_name: Buddy
phone_number: '18003385504'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 23950
id: 10086
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 11369
- 4510
- _parent_object_id: null
id: 23222
email: null
position: null
badge_id: null
owner_id: 15636
first_name: Liza
last_name: Miller
phone_number: '1555888999'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/20956_15636-20230524_100445_147.jpg?1684947885
status: active
department_ids: []
user:
_parent_object_id: 23222
id: 15636
skill_ids: []
channel_ids:
- 12876
- 13863
- 12457
- 13931
- 4743
- 13174
- 11478
- 11476
- 4927
- 7613
- 14289
- _parent_object_id: null
id: 23692
email: null
position: null
badge_id: null
owner_id: 7959
first_name: LocalAuth
last_name: 0009
phone_number: '18888880009'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 23692
id: 7959
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 8278
- 8279
- 7928
- _parent_object_id: null
id: 23938
email: null
position: null
badge_id: null
owner_id: 11507
first_name: Localization
last_name: Employée
phone_number: '18888881129'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/9444_6022-20190128_113759_022.jpg?1548704289
status: active
department_ids: []
user:
_parent_object_id: 23938
id: 11507
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 11369
- 4510
- _parent_object_id: null
id: 24075
email: steve@myshyft.com
position: null
badge_id: null
owner_id: 9190
first_name: Locked Location
last_name: Ios Registration
phone_number: '18003330003'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 24075
id: 9190
skill_ids: []
channel_ids:
- 4927
- 7613
- 4510
- _parent_object_id: null
id: 23806
email: null
position: null
badge_id: null
owner_id: 12082
first_name: 'Login '
last_name: Tester
phone_number: '18888881535'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 23806
id: 12082
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 11369
- 10619
- 7928
- _parent_object_id: null
id: 23659
email: null
position: null
badge_id: null
owner_id: 13383
first_name: Loryn
last_name: Bortins 01
phone_number: '18888882345'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 23659
id: 13383
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 7217
- 10688
- 7928
- 10617
- 10619
- 10600
- 8277
- 8279
- 10535
- 10537
- _parent_object_id: null
id: 23745
email: loryn@myshyft.com
position: null
badge_id: null
owner_id: 11794
first_name: Loryn
last_name: Bortins
phone_number: '14252216552'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 23745
id: 11794
skill_ids: []
channel_ids:
- 13863
- 4927
- 3996
- 4000
- 3999
- 4001
- 4003
- 3885
- 4028
- 4002
- 4327
- 3997
- 7836
- 7832
- 7827
- 7644
- 7795
- 7698
- 7604
- 7591
- 7253
- 7328
- 7691
- 4918
- 7692
- 7294
- 7690
- 7768
- 7767
- 7760
- 7758
- 7314
- 7598
- 7757
- 7756
- 7340
- 7684
- 7685
- 7799
- 7659
- 7798
- 7797
- 4930
- 7600
- 7699
- 7790
- 7789
- 7696
- 7801
- 7700
- 7759
- 7339
- 7842
- 7819
- 7816
- 7833
- 7599
- 7925
- 7746
- 7875
- 7809
- 7839
- 7808
- 7826
- 7755
- 7761
- 7262
- 7694
- 7693
- 7701
- 4917
- 7818
- 7817
- 7597
- 7815
- 7682
- 7814
- 7800
- 7813
- 10688
- 3966
- 10619
- 8199
- 7928
- 3797
- 7613
- 3984
- 8195
- 4510
- _parent_object_id: null
id: 23679
email: null
position: null
badge_id: null
owner_id: 13510
first_name: Louis
last_name: Frami
phone_number: '18885550018'
profile_image_thumb_url: https://miniobackingstore.blob.core.windows.net/coffeemobile/images/thumb/10620_13510-20190916_153820_856.jpg?1568673501
status: active
department_ids: []
user:
_parent_object_id: 23679
id: 13510
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 11370
- 7928
- 10807
- 8367
- 10688
- 7780
- _parent_object_id: null
id: 23903
email: null
position: null
badge_id: null
owner_id: 11716
first_name: M
last_name: M
phone_number: '18888881413'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 23903
id: 11716
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 11369
- 7928
- 10688
- 10619
- 8199
- 8195
- 8034
- 7974
- 7967
- 8033
- 8026
- 8035
- 8025
- 7968
- 8031
- 8023
- 8029
- 8032
- 8027
- 7972
- 8021
- 8028
- 8020
- 8024
- 8018
- 8012
- 8022
- 8014
- 8017
- 7966
- 8005
- 8016
- 8030
- 8013
- 8004
- 8015
- 8011
- _parent_object_id: null
id: 23753
email: molly@myshyft.com
position: null
badge_id: null
owner_id: 11572
first_name: Maggie
last_name: Smith
phone_number: '18014288341'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 23753
id: 11572
skill_ids: []
channel_ids:
- 13863
- 4927
- 7613
- 10688
- 10619
- 8199
- 7928
- 8195
- _parent_object_id: null
id: 24022
email: null
position: null
badge_id: null
owner_id: 9332
first_name: Manager
last_name: Swift
phone_number: '18003333336'
profile_image_thumb_url: https://files.myshyft.com/shyft-app-images/avatar1.png
status: active
department_ids: []
user:
_parent_object_id: 24022
id: 9332
skill_ids: []
channel_ids:
- 4927
- 7613
- 11369
# --- truncated at 32 KB (542 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shyft/refs/heads/main/openapi/shyft-compact-userprivileges-api-openapi.yml