Skip to main content
GET
List Sales Associates

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sales_associate_ids
string

Sales Associate id owned by the brand

from
string

Only show reminders updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

to
string

Combined with the from parameter, only show reminders updated whitin the given range (from..to) time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

page
string

Page number of the results to fetch. Default: 1

per_page
string

Results per page (max 100). Default: 30

Response

200 - application/json

Successful response, returns array of Sales Associates

current_store_id
string | null
required

Unique identifier of the store where associate is assigned to

associate_id
string | null
required

Unique identifier of the associate

associate_id_2
string | null
required

Second unique identifier of the associate

sales_associate_name
string | null
required

Full name of the associate

username
string | null
required

Associate's username that they use to login to BSPK

email
string | null
required

Associate's email

mobile_phone
string | null
required

Associate's mobile phone

job_title
string | null
required

Associate's job title

wechat_enabled
boolean | null
required

Whether or not the associate has wechat enabled

wechat_code
string | null
required

Wechat code whenever it has wechat enable.

imessage_enabled
boolean | null
required

Whether or not the associate has Apple Messages enabled

line_enabled
boolean | null
required

Whether or not the associate has Line enabled

adyen_enabled
boolean | null
required

Whether or not the associate has Adyen Pay by Link enabled

created_at
string<date_time>
required

Timestamp of when the note was created

updated_at
string<date_time>
required

Timestamp of when the note was updated