Get a List of Seller Active or Invited Users

GET /api/v1/users

Base URL: https://user-management-api.wildberries.ru · Module: general · Section: Seller User Management · Specification doc ↗

Method is available by Personal token

The method returns a list of seller account active or invited users.

Specify the value of the isInviteOnly parameter to select the list:

• isInviteOnly=true — invited users list who have not yet activated access
• isInviteOnly=false or is not provided — active users list For each user, you can get:
• user's role
• accessible sections
• invitation status The list of invited users in the response is always sorted by creation date: from newest to oldest.

Request limit per one seller account:

Period	Limit	Interval	Burst
1 s	1 request	1 s	5 requests

Parameters

Name	In	Type	Req.	Description
limit	query	integer<int64>	no	The number of active or invited users in the response
offset	query	integer<int64>	no	How many results to skip. For example, for the value 10, the response will start with the 11 element
isInviteOnly	query	boolean	no	- true — the list of invited users who have not yet activated access - false or not provided — the list of active users of the seller account

Responses

Code	Description	Schema
200	Success	getUsersResponse
400	Bad request	errorResponse
401	Unauthorized	object
403	Access denied	Response4XX
429	Too many requests	object

Structure 200:

• total integer<int64> — The total number of active or invited users in the list
• countInResponse integer<int64> — The number of active or invited users on the current page
• users object[] — User information
  • id integer<int64> — User ID
  • role string = user | `` — User role: * user — user who have activated access * (empty string) — user who have not yet activated access
  • position string — User's position
  • phone string — User's phone number
  • email string — User's email
  • isOwner boolean — Is the user the seller account's owner
  • firstName string — User's first name
  • secondName string — User's last name
  • patronymic string — User's patronymic
  • goodsReturn boolean — Can user approve item returns
  • isInvitee boolean — Is the user invited
  • inviteeInfo object — Invitation information, if the user is invited
    • phoneNumber string — Invited user's phone number
    • position string — Invited user's position
    • inviteUuid string<UUID> — Invitation ID
    • expiredAt string — Invitation expiration date and time
    • isActive boolean — - true — the invitation is active - false — the invitation is inactive
  • access object[] — Access settings for seller account sections
    • code string = balance | brands | changeJam | discountPrice | finance | showcase | suppliersDocuments | supply | questions | pinFeedbacks | pointsForReviews | feedbacks | oldAnalyticsReports | marketplace | brandsFlow | copyrightComplaints | pretrialClaims | sellersChat | brandzone | brandzoneSubscribe — The code for the seller account section the user will get access to: * balance — View balance and withdraw funds * brands — Brands management * changeJam — Access to Jam subscription: A/B tests, photo tags, video autostarts, listing comparisons * discountPrice — Change item prices, manage discounts and promos * finance — Financial analytics. Balance statistics, financial reports, payment history * showcase — Showcase management * suppliersDocuments — View and download documents related to platform operations * supply — Create and manage FBW supplies * questions — View and respond to customer questions * pinFeedbacks — Ability to pin and unpin reviews * pointsForReviews — Points for reviews * feedbacks — View and respond to customer reviews * oldAnalyticsReports — Reports * marketplace — Seller Warehouse * brandsFlow — My brands * copyrightComplaints — Copyright Claims * pretrialClaims — Out-of-Court Claims * sellersChat — Chat with Users * brandzone — Edit Brand Zone * brandzoneSubscribe — Manage Brand Zone Subscription
    • disabled boolean — * true — access to the section is disabled * false — access to the section is enabled

Structure 400:

• title string — Error title
• detail string — Error details
• requestId string — Request ID
• origin string — Internal service name
• status number — HTTP status code

Structure 401:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Unique request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Structure 403:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Structure 429:

• title string — Error title
• detail string — Error details
• code string — Internal error code
• requestId string — Unique request ID
• origin string — WB internal service ID
• status number — HTTP status code
• statusText string — Text of the HTTP status code
• timestamp string — Request date and time

Call examples

Arguments are shown as parameter names — substitute your own values. Languages whose client does not expose this operation are omitted.

Python

from wb_api_client.general import Configuration, ApiClient
from wb_api_client.general.api import GeneralApi

cfg = Configuration(access_token="<your WB JWT>")
api = GeneralApi(ApiClient(cfg))

result = api.get_v1_users(limit=..., offset=..., is_invite_only=...)
print(result)

TypeScript

import {
  Configuration,
  GeneralApi,
} from "@valeryverkhoturov/wb-api-client/general";

const cfg = new Configuration({});
cfg.setAccessToken("<your WB JWT>");
const api = new GeneralApi(cfg);

const { data } = await api.getV1Users(limit, offset, isInviteOnly);
console.log(data);

Go

import (
	"context"
	"fmt"

	wbgeneral "github.com/ValeryVerkhoturov/wb-api-client-go/general"
)

cfg := wbgeneral.NewConfiguration()
cfg.SetAccessToken("<your WB JWT>")
client := wbgeneral.NewAPIClient(cfg)

result, _, err := client.GeneralAPI.GetV1Users(context.Background()).Execute()
if err != nil {
    panic(err)
}
fmt.Printf("%+v\n", result)

Java

import io.github.valeryverkhoturov.wbapi.general.ApiClient;
import io.github.valeryverkhoturov.wbapi.general.SecretString;
import io.github.valeryverkhoturov.wbapi.general.api.GeneralApi;

ApiClient client = new ApiClient();
client.setAccessToken(new SecretString("<your WB JWT>"));
GeneralApi api = new GeneralApi(client);

System.out.println(api.getV1Users(limit, offset, isInviteOnly));

PHP

use ValeryVerkhoturov\WbApiClient\General\Configuration;
use ValeryVerkhoturov\WbApiClient\General\SecretString;
use ValeryVerkhoturov\WbApiClient\General\Api\GeneralApi;
use GuzzleHttp\Client;

$config = (new Configuration())
    ->setAccessTokenSecret(new SecretString('<your WB JWT>'));
$api = new GeneralApi(new Client(), $config);

print_r($api->getV1Users());

OneScript

#Использовать "wb-api-client"

Настройки = Новый Конфигурация();
Настройки.УстановитьТокен("<your WB JWT>");
Клиент = Новый GeneralApi(Настройки);

Сообщить(Клиент.GetV1Users().Тело);

C#

using ValeryVerkhoturov.WbApiClient.General.Api;
using ValeryVerkhoturov.WbApiClient.General.Client;

var config = new Configuration();
config.AccessTokenSecret = new SecretString("<your WB JWT>");
var api = new GeneralApi(config);

Console.WriteLine(api.GetV1Users());

Rust

use wb_api_client::general::apis::{configuration::Configuration, general_api};

#[tokio::main]
async fn main() {
    let mut cfg = Configuration::new();
    cfg.set_access_token("<your WB JWT>");

    let result = general_api::get_v1_users(&cfg, limit, offset, is_invite_only).await;
    println!("{:#?}", result);
}