List Sales Staff | BigCommerce Developer Center

import requests
url = "https://api-b2b.bigcommerce.com/api/v3/io/sales-staffs"
querystring = {"companyId":"123456","minModified":"1721835018"}
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers, params=querystring)
print(response.json())

{
  "code": 200,
  "data": [
    {
      "companyCount": 5,
      "email": "marie.curie@sales.example.com",
      "id": 20135,
      "roleName": "Sales Rep",
      "salesRepName": "Marie Curie"
    },
    {
      "companyCount": 8,
      "email": "nikola.tesla@sales.example.com",
      "id": 20136,
      "roleName": "Sales Rep",
      "salesRepName": "Nikola Tesla"
    },
    {
      "companyCount": 3,
      "email": "ada.lovelace@sales.example.com",
      "id": 20137,
      "roleName": "Sales Rep",
      "salesRepName": "Ada Lovelace"
    },
    {
      "companyCount": 7,
      "email": "alan.turing@sales.example.com",
      "id": 20138,
      "roleName": "Sales Rep",
      "salesRepName": "Alan Turing"
    },
    {
      "companyCount": 6,
      "email": "grace.hopper@sales.example.com",
      "id": 20139,
      "roleName": "Sales Rep",
      "salesRepName": "Grace Hopper"
    },
    {
      "companyCount": 4,
      "email": "katherine.johnson@sales.example.com",
      "id": 20140,
      "roleName": "Sales Rep",
      "salesRepName": "Katherine Johnson"
    },
    {
      "companyCount": 9,
      "email": "tim.berners-lee@sales.example.com",
      "id": 20141,
      "roleName": "Sales Rep",
      "salesRepName": "Tim Berners-Lee"
    },
    {
      "companyCount": 2,
      "email": "rosalind.franklin@sales.example.com",
      "id": 20142,
      "roleName": "Sales Rep",
      "salesRepName": "Rosalind Franklin"
    },
    {
      "companyCount": 5,
      "email": "charles.babbage@sales.example.com",
      "id": 20143,
      "roleName": "Sales Rep",
      "salesRepName": "Charles Babbage"
    },
    {
      "companyCount": 3,
      "email": "jane.goodall@sales.example.com",
      "id": 20144,
      "roleName": "Sales Rep",
      "salesRepName": "Jane Goodall"
    }
  ],
  "meta": {
    "message": "SUCCESS",
    "pagination": {
      "limit": 10,
      "offset": 0,
      "totalCount": 179
    }
  }
}

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

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 that can be returned for a modified Company account.

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

codeintegerDefaults to 200

HTTP response code for the request.

datalist of objects

Data array associated with the response.

metaobject

Metadata associated with the response.