Skip to content

Sales persons

Returns list of sales persons in the system. Returned data can be limited with salesperson_id query parameters.

Operations

Download sales persons as JSON

Request

GET https://api.zoined.com/v2/download/salesPersons.json?limit=1000&offset=0&salesperson_id=123k

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
salesperson_idstring

Returns data for sales person based on the given id

Example:salesperson_id=123k
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/salesPersons.json?limit=1000&offset=0&salesperson_id=123k' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
salesperson_idstringrequired

Sales person ID

Example:"5402101"
salesperson_namestring

Sales person name

Example:"John Smith"
salesperson_emailstring

Sales person email

Example:"john.smith@store.store"
salesperson_phonestring

Sales person phone number

Example:"+35811111111"
employment_startstring

Employment start date

Example:"2020-01-01"
employment_endstring

Employment end date

Example:"2020-05-31"
custom_field_1string

Custom Field 1

Example:"Project worker"
custom_field_2string

Custom Field 2

Example:"Project worker"
custom_field_3string

Custom Field 3

Example:"Project worker"
custom_field_4string

Custom Field 4

Example:"Project worker"
custom_field_5string

Custom Field 5

Example:"Project worker"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
Response
{
  "salesperson_id": "5402101",
  "salesperson_name": "John Smith",
  "salesperson_email": "john.smith@store.store",
  "salesperson_phone": "+35811111111",
  "employment_start": "2020-01-01",
  "employment_end": "2020-05-31",
  "custom_field_1": "Project worker",
  "custom_field_2": "Project worker",
  "custom_field_3": "Project worker",
  "custom_field_4": "Project worker",
  "custom_field_5": "Project worker",
  "custom_metric_1": 1,
  "custom_metric_2": 100,
  "custom_metric_3": 2.2,
  "custom_metric_4": 1.05,
  "custom_metric_5": 10000
}