Awesome Support Developer Documentation

Users: Schema

Schema

The schema defines all the fields that exist for a user object.

id
integer 		Unique identifier for the user.

Read only

Context: embed, view, edit
username
string 		Login name for the user.

Context: edit
name
string 		Display name for the user.

Context: embed, view, edit
first_name
string 		First name for the user.

Context: edit
last_name
string 		Last name for the user.

Context: edit
email
string, email 		The email address for the user.

Context: edit
url
string, uri 		URL of the user.

Context: embed, view, edit
description
string 		Description of the user.

Context: embed, view, edit
locale
string 		Locale for the user.

Context: edit

One of: , en_US
nickname
string 		The nickname for the user.

Context: edit
slug
string 		An alphanumeric identifier for the user.

Context: embed, view, edit
registered_date
string, datetime (ISO8601) 		Registration date for the user.

Read only

Context: edit
roles
array 		Roles assigned to the user.

Context: edit
password
string 		Password for the user (never included).

Context:

capabilities
object 		All capabilities assigned to the user.

Read only

Context: edit
extra_capabilities
object 		Any extra capabilities assigned to the user.

Read only

Context: edit
avatar_urls
object 		Avatar URLs for the user.

Read only

Context: embed, view, edit
meta
object 		Meta fields.

Context: view, edit
wpas_can_be_assigned
boolean 		Can the system assign new tickets to this user?

Context: embed, view, edit
wpas_smart_tickets_order
boolean 		If Smart Tickets Order is enabled, Awesome Support will display tickets that need immediate attention at the top.

Context: embed, view, edit
wpas_after_reply
string 		If Smart Tickets Order is enabled, Awesome Support will display tickets that need immediate attention at the top.

Context: embed, view, edit

One of: stay, back, ask

Example Request

$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wpas-api/v1/users

 

Share: