List Company Users

GET

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

GET

/api/v2/companies/:companyId/users

curl -G https://api-b2b.bigcommerce.com/api/v2/companies/123/users \
     -H "Authorization: Bearer <token>" \
     -d limit=10 \
     -d maxLastCreatedTime=1618794615 \
     -d maxLastModifiedTime=1618794615 \
     -d minLastCreatedTime=1618794615 \
     -d minLastModifiedTime=1618794615 \
     -d offset=0 \
     -d "role[]=0"

200Retrieved

{
  "message": "string",
  "code": 200,
  "data": {
    "list": [
      {
        "firstName": "Marie",
        "lastName": "Curie",
        "email": "m.curie@greatbuys.com",
        "id": "123",
        "role": "1",
        "phoneNumber": "8001234567",
        "createdAt": "1618794615",
        "updatedAt": "1618794615",
        "uuid": "string",
        "catalogId": "123456"
      }
    ],
    "pagination": {
      "totalCount": 175,
      "offset": 0,
      "limit": 10
    }
  }
}

Returns a list of users associated with a Company account.

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

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[…]

Path parameters

companyIdstringRequired

The unique numeric ID of the Company account.

Query parameters

role[]enumOptional

The ID of the role assigned to the Company user account as defined at Specifying User Role.

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.

qstringOptional

The search string for the request.

minLastModifiedTimestringOptional

The earliest Unix timestamp for when the Company account was modified that can be returned.

maxLastModifiedTimestringOptional

The latest Unix timestamp for when the Company account was modified that can be returned.

minLastCreatedTimestringOptional

The earliest Unix timestamp for when the Company account was created that can be returned.

maxLastCreatedTimestringOptional

The earliest Unix timestamp for when the Company account was created that can be returned.

Response

messagestringOptional

codedoubleOptionalDefaults to 200

dataobjectOptional