v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Users

Get a user

get/users/{user_id}

Response

user_idinteger

first_namestring

last_namestring

phonestring nullable

emailstring

group_idinteger

imagestring nullable

last_logininteger nullable

ip_whiteliststring nullable

api_keystring nullable

user_type'ui' | 'api_key'

ui - User Interface
api_key - API Key

password_type'ui' | 'email' | 'api_key'

ui - Define the password with the password paramter
email - Email the password to the user
api_key - API Key

user_defaultboolean

user_identifierstring nullable

date_createdstring date-time nullable

created_byinteger

date_modifiedstring date-time

modified_byinteger

activeboolean

notesstring nullable

campaign_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

company_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

item_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

merchant_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

offer_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

product_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

responder_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

route_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

user_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

order_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

transaction_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

customer_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

shipment_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

report_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

dunning_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

connection_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

merchant_group_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

user_group_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

user_password_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

team_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

return_profile_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

chargeback_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

api_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

bin_profile_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

tax_profile_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

timeframe_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

dashboard_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

widget_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

counter_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

alert_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

schedule_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

user_permission_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

cohort_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

discount_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

shipping_profile_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

gift_card_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

order_offer_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

quantity_discount_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

upsell_profile_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

tracker_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

payment_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

view_user_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

view_group_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

refund_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

store_credit_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

ruleset_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

promotional_profile_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

reward_profile_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

tag_permission_level_id1 | 2 | 3 | 4

1 - No Access
2 - Read Only
3 - Create/Edit
4 - Full Access

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00"
}