RESTB2BManagementSales Staff

List Sales Staff

Returns an array of all B2B Edition users who are assigned to a user role that is labelled as Sales Staff.

Authentication

X-Auth-Tokenstring
| Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). | For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
X-Store-Hashstring
| Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Query parameters

limitintegerOptionalDefaults to 10
Maximum number of results to display per page.
offsetintegerOptionalDefaults to 0
Number of results to skip before displaying the current page.
orderByenumOptionalDefaults to DESC

Sort direction of results, ascending or descending, applied to the sortBy parameter.

Allowed values:
companyIdstringOptional
Unique numeric ID of the Company account.
minModifiedintegerOptional
The earliest [Unix timestamp](https://www.unixtimestamp.com/) that can be returned for a modified Company account.
sortByenumOptionalDefaults to updated_at
Field by which data should be sorted in the response.
Allowed values:

Response

OK
codeintegerDefaults to 200
The HTTP Status code of the response.
datalist of any
metaobject