GET
/
sales-reps
Get Sales Rep List
curl --request GET \
  --url https://api.wizcommerce.com/v1/sales-reps \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+14155552671",
      "department": "Sales",
      "status": "active",
      "created_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
      "updated_by": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Query Parameters

​
page
integer
Required range: x >= 1
​
page_size
integer
Required range: 1 <= x <= 100
​
email
string

LIKE search, case sensitive

​
sort
enum<string>
default:desc
Available options:
asc,
desc
​
sort_by
enum<string>
default:updated_at
Available options:
created_at,
updated_at,
first_name,
last_name
​
status
enum<string>
default:active
Available options:
active,
inactive

Response

200
application/json

OK

The response is of type object.