Search staff accounts

GET https://app.ecwid.com/api/v3/{storeId}/staff

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
        }
    ]
}

Required access scopes

Your app must have the following access scopes to make this request: read_staff

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Query params

All query params are optional.

Name	Type	Description
responseFields	string	Specify the exact fields to receive in response JSON. If not specified, the response JSON will have all available fields for the entity. For example: ?responseFields=staffList(name,email,inviteAccepted)

Example of using responseFields param:

Request

curl --location 'https://app.ecwid.com/api/v3/1003/staff?responseFields=staffList(name,email,inviteAccepted)' \
--header 'Authorization: Bearer secret_ab***cd'

Response

{
    "staffList": [
        {
            "name": "John Doe",
            "email": "[email protected]",
            "inviteAccepted": true
        },
        {
            "name": "API Team",
            "email": "[email protected]",
            "inviteAccepted": true
        }
    ]
}

Headers

The Authorization header is required.

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

Response JSON

A JSON object with the following fields:

Field	Type	Description
staffList	array of objects staffList	Details about staff accounts invited to the store.

staffList

Field	Type	Description
id	string	Internal unique ID of the staff account.
name	string	Staff account name.
email	string	Staff account email.
staffScopes	array of strings	Permissions enabled for the staff account. If empty, the account has all permissions. Learn more about staff account permissions in Help Center.
inviteAccepted	boolean	Defines if user accepted their invite to become staff account for the store.