Search staff accounts

Get all available information about existing staff accounts in the store.

Request and response example

Request:

curl --location 'https://app.ecwid.com/api/v3/1003/staff' \
--header 'Authorization: Bearer secret_ab***cd'

Response:

{
    "staffList": [
        {
            "id": "p27632593",
            "name": "John Doe",
            "email": "[email protected]",
            "staffScopes": [
                "REPORT_ACCESS",
                "SALES_MANAGEMENT",
                "MARKETING_MANAGEMENT"
            ],
            "inviteAccepted": true
        },
        {
            "id": "p3855016",
            "name": "API Team",
            "email": "[email protected]",
            "staffScopes": [
                "REPORT_ACCESS",
                "WEBSITE_MANAGEMENT",
                "STORE_MANAGEMENT",
                "CATALOG_MANAGEMENT",
                "SALES_CHANNELS_MANAGEMENT",
                "SALES_MANAGEMENT",
                "MARKETING_MANAGEMENT"
            ],
            "inviteAccepted": true
        }
    ]
}

Access scopes

Requires the following access scope: read_staff

Path params

ParamTypeDescription
storeIdnumberEcwid store ID.

Query params

All query params are optional.

ParamTypeDescription
responseFieldsstringLimit JSON response by specific fields. If specified, all missing fields will be removed from the response body.
Example: ?responseFields=staffList(name,email,inviteAccepted)

Example of using responseFields param:

curl --location 'https://app.ecwid.com/api/v3/1003/staff?responseFields=staffList(name,email,inviteAccepted)' \
--header 'Authorization: Bearer secret_ab***cd'
{
    "staffList": [
        {
            "name": "John Doe",
            "email": "[email protected]",
            "inviteAccepted": true
        },
        {
            "name": "API Team",
            "email": "[email protected]",
            "inviteAccepted": true
        }
    ]
}

Headers

The Authorization header with a secret access token is required.

HeaderFormatDescription
AuthorizationBearer secret_ab***cdAccess token of the application.

Response

A JSON object with the following fields:

FieldTypeDescription
staffListObject staffListDetails about staff accounts invited to the store.

staffList

FieldTypeDescription
idstringUnique staff account ID.
namestringStaff account name.
emailstringStaff account email.
staffScopesArray of stringsPermissions enabled for the staff account. See: Get staff account scopes
If empty, the account has all permissions. Check Help Center for more information.
inviteAcceptedbooleanSpecifies if invite is accepted: true if accepted, false if not.
Language
Click Try It! to start a request and see the response here!