salesman

Retrieves seller information

get/v0/salesman/{salesman_id}

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v0/salesman/{salesman_id}
  • Auth: OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Path parameters

salesman_idstring required

salesman ID

Headers

authorizationstring required

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

x-api-keystring required

Api_key provided by ClubMed API team

Response

ok

first_namestring required

seller first name

last_namestring required

seller last name

emailstring required

seller email

salesman_idstring required

seller salesman id

sales_network_idstring required

seller sales network id

agency_full_namestring required

seller agency full name

partner_idstring required

seller partner id

access_level'NETWORK' | 'AGENCY' | 'USER' required

Indicates the visibility access level of the concerned salesman

agency_managerboolean required

indicates if this seller is his agency manager

localesstring[] required

List of allowed locales for this seller

Example response

{
  "first_name": "John",
  "last_name": "Smith",
  "email": "johnsmith@gmail.com",
  "salesman_id": "123456789",
  "sales_network_id": "OPERA_00_P2T",
  "agency_full_name": "OPERA Agency",
  "partner_id": "CME12345",
  "access_level": "AGENCY",
  "agency_manager": true,
  "locales": [
    "en-US"
  ],
  "phones": [
    {
      "number": "0623456789",
      "type": "MOBILE"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.