List Users

GET

https://api-b2b.bigcommerce.com/api/v2/users

Returns a list of a Company’s users by role. Equivalent Storefront GraphQL API Query: `users`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). The `role` parameter allows you to filter for users that have a predefined Company role. You can also view all users in a Company, or users with an unknown role.

List Users

GET

https://api-b2b.bigcommerce.com/api/v2/users

Returns a list of a Company’s users by role.

Equivalent Storefront GraphQL API Query: users. For more information, see the GraphQL Playground.

The role parameter allows you to filter for users that have a predefined Company role. You can also view all users in a Company, or users with an unknown role.

Authentication

AuthorizationBearer

Authentication header

Header	Argument	Description
`Authorization`	`Bearer {{B2B_JWT_TOKEN}}`	You can obtain this token using the steps described in the REST Storefront API section[…]

Query parameters

qstringOptional

The search string for the request.

roleenumRequired

The ID of the role assigned to the Company user account as given below.

Value	Code
0	Admin
1	Senior Buyer
2	Junior Buyer
3	Super Admin
4	Unknown

Allowed values:

limitstringOptionalDefaults to 10

The total number of items per page of the response.

offsetstringOptional

The number of items to skip before the current page of the response.

Response

messagestring

codedoubleDefaults to 200

dataobject

$	curl -G https://api-b2b.bigcommerce.com/api/v2/users \
>	-H "Authorization: Bearer <token>" \
>	-d role=0 \
>	-d limit=10 \
>	-d offset=0

1	{
2	"message": "string",
3	"code": 200,
4	"data": {
5	"list": [
6	{
7	"firstName": "Marie",
8	"lastName": "Curie",
9	"email": "m.curie@greatbuys.com",
10	"id": "123",
11	"role": "1",
12	"phoneNumber": "8001234567",
13	"createdAt": "1618794615",
14	"updatedAt": "1618794615"
15	}
16	],
17	"pagination": {
18	"totalCount": 175,
19	"offset": 0,
20	"limit": 10
21	}
22	}
23	}

$	curl -G https://api-b2b.bigcommerce.com/api/v2/users \
>	-H "Authorization: Bearer <token>" \
>	-d role=0 \
>	-d limit=10 \
>	-d offset=0

1	{
2	"message": "string",
3	"code": 200,
4	"data": {
5	"list": [
6	{
7	"firstName": "Marie",
8	"lastName": "Curie",
9	"email": "m.curie@greatbuys.com",
10	"id": "123",
11	"role": "1",
12	"phoneNumber": "8001234567",
13	"createdAt": "1618794615",
14	"updatedAt": "1618794615"
15	}
16	],
17	"pagination": {
18	"totalCount": 175,
19	"offset": 0,
20	"limit": 10
21	}
22	}
23	}