get https://app.ecwid.com/api/v3//staff
Get all available information about existing staff accounts in the store.
To get the information about staff accounts use secret token. The
read_staff
access scope is required. Reach out to us at [email protected] to add the scope.
Headers
Name | Type | Description |
---|---|---|
Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0 , where e***s0 should be replaced with your oAuth token. |
Response
A JSON object with the following fields:
Subscription
Field | Type | Description |
---|---|---|
staffList | obj<StaffList> | List of staff accounts invited to the store |
StaffList
Field | Type | Description |
---|---|---|
id | string | Staff account ID |
name | string | Staff member name |
string | Account email | |
staffScopes | string | Scopes declaring permissions for the staff account. See: Get staff permissions Empty value = no restrictions. Check Help Center for more i |
inviteAccepted | boolean | Specifies if invite is accepted. Possible values: true if accepted, false if not |