Get staff account

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

Request and response example

Request:

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

Response:

{
    "email": "[e-mail]",
    "staffScopes": [
        "SALES_MANAGEMENT",
        "CATALOG_MANAGEMENT",
        "WEBSITE_MANAGEMENT",
        "MARKETING_MANAGEMENT",
        "REPORT_ACCESS",
        "SALES_CHANNELS_MANAGEMENT",
        "STORE_MANAGEMENT"
    ]
}

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.
staffAccountId	string	Internal staff account 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=staffScopes

Example of using responseFields param:

Request

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

Response

{
    "staffScopes": [
        "SALES_CHANNELS_MANAGEMENT",
        "REPORT_ACCESS",
        "CATALOG_MANAGEMENT",
        "STORE_MANAGEMENT",
        "SALES_MANAGEMENT",
        "MARKETING_MANAGEMENT",
        "WEBSITE_MANAGEMENT"
    ]
}

Headers

The Authorization header is required.

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

Field	Type	Description
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.