staffMember

query

Enterprise

Requires read_store_staff access scope.

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Query information for a specific staff member in the store. You can use the UID to query the staff member's name, phone number, email, and other details.

Arguments

uid ● ID!non-null

Staff member UID.

Return

uid ● ID

Staff member UID.

phone ● String

Staff member phone number.

name ● String

Staff member name.

active ● Boolean!non-null

Whether the staff member’s account is active.

true: active
false: inactive

isShopOwner ● Boolean!non-null

Whether the staff member is the store owner.

true: The staff member is the store owner.
false: The staff member is not the store owner.

email ● String

Staff member email.

Status and error codes

For detailed information about common codes, see Status and error codes.

Example

Query a specific store staff member

Code

query MyQuery {
    staffMember(
        uid: "111"
    ) {
        uid
        phone
        name
        active
        isShopOwner
        email
    }
}

Response

{
	"data": {
		"isShopOwner": true,
		"name": "test",
		"phone": "13000000000",
		"uid": "111",
		"active": true,
		"email": "test@163.com"
	}
}

Was this article helpful to you?

SHOPLINE

Legal