Get an ambassador (widget)

GET /widget/ambassadors/{id}

Headers

  • X-Popsell-Domain string Required

    The domain of the user

Path parameters

  • id integer Required

    The ambassador id

Responses

  • 200 application/json

    Returns the ambassador

    Hide response attributes Show response attributes object
    • id_ambassador integer(int32)
    • image string(nullable)
    • full_name string
    • username string(nullable)
    • description string
    • status integer(int32)
    • availability string(nullable)
    • unavailable boolean
    • is_absent boolean
    • absent_msg string(nullable)
    • fb_account string(nullable)
    • twitter_account string(nullable)
    • instagram_account string(nullable)
    • linkedIn_account string(nullable)
    • youtube_account string(nullable)
    • online boolean

      true: when last_action_date is less than 5 minutes ago

    • last_action_date string
    • location string

      Label of the point of sale, or city of the ambassador

    • address_geocode object

      Additional properties are allowed.

      Hide address_geocode attributes Show address_geocode attributes object
      • date_insert string(date-time)
      • date_update string(date-time)
      • latitude string
      • longitude string
      • city string
      • country string
      • postcode string
      • street string
      • street2 string
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
    • message string
  • 404

    Not found - The ambassador does not exist

GET /widget/ambassadors/{id} 
curl \
 --request GET 'https://domain.tld/api/v2/widget/ambassadors/{id}' \
 --header "X-Popsell-Domain: example.com"
Response examples (200) 
{
  "id_ambassador": 42,
  "image": "string",
  "full_name": "string",
  "username": "string",
  "description": "string",
  "status": 42,
  "availability": "string",
  "unavailable": true,
  "is_absent": true,
  "absent_msg": "string",
  "fb_account": "string",
  "twitter_account": "string",
  "instagram_account": "string",
  "linkedIn_account": "string",
  "youtube_account": "string",
  "online": true,
  "last_action_date": "string",
  "location": "Paris",
  "address_geocode": {
    "date_insert": "2025-05-04T09:42:00Z",
    "date_update": "2025-05-04T09:42:00Z",
    "latitude": "48.856614",
    "longitude": "2.3522219",
    "city": "Paris",
    "country": "France",
    "postcode": "75001",
    "street": "Rue de Rivoli",
    "street2": "Place de la Concorde"
  }
}
Response examples (401) 
{
  "message": "Unauthorized."
}