Headers

• X-Popsell-Brand integer Required

  The id of the target brand

Query parameters

• sort string

  Sort chatrooms by one of the following fields

  Value is last_action_date.

• filter[brand_tag] integer

  retrieve ambassadors by brand tag id

• filter[name] string

  retrieve ambassadors by first name, last name or username

• filter[status] integer

  Filter by ambassador status (0: ambassador, 1: employee, 2: administrator, 3: seller, 4: shop manager, 5: manager, 6: expert, 7: client, 8: temp) ex: ?filter[status]=7,8 will return ambassadors with status client or temp

  Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.

• filter[social_community_display] integer

  Filter by social community display (0: hidden, 1: visible)

  Values are 0 or 1.

• filter[exclude] integer

  Exclude ambassadors by id

Responses

• 200 application/json

  Returns all ambassadors (paginated)

  Hide response attributes Show response attributes object

  • current_page integer(int32)
  • data array[object]
    Hide data attributes Show data attributes object

    • id_ambassador integer(int32)
    • image string
    • firstname string
    • lastname string
    • username string
    • email string
    • email_tmp string
    • active integer(int32)
    • status integer(int32)
    • online boolean

      true: when last_action_date is less than 5 minutes ago

    • last_action_date string(date-time)
    • customer_id string
    • anonymized boolean
  • first_page_url string
  • from integer(int32)
  • last_page integer(int32)
  • last_page_url string
  • links array[object]
    Hide links attributes Show links attributes object

    • url string(nullable)
    • label string
    • active boolean
  • next_page_url string
  • path string
  • per_page integer(int32)
  • prev_page_url string(nullable)
  • to integer(int32)
  • total integer(int32)
• 401 application/json

  Unauthorized.

  Hide response attribute Show response attribute object

  • message string
• 403

  Forbidden - You don't have permission to access this route