Search staff accounts

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

Param	Type	Description
storeId	number	Ecwid store ID.

Query params

All query params are optional.

Param	Type	Description
responseFields	string	Limit 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.

Header	Format	Description
Authorization	`Bearer secret_ab***cd`	Access token of the application.

Response

A JSON object with the following fields:

Field	Type	Description
staffList	Object staffList	Details about staff accounts invited to the store.

staffList

Field	Type	Description
id	string	Unique staff account ID.
name	string	Staff account name.
email	string	Staff account email.
staffScopes	Array of strings	Permissions enabled for the staff account. See: Get staff account scopes If empty, the account has all permissions. Check Help Center for more information.
inviteAccepted	boolean	Specifies if invite is accepted: `true` if accepted, `false` if not.